The Global Digital Library (GDL) APIs are developed to support reuse of content from the GDL on other platforms. All content and curriculum metadata on the GDL platform can be used across all major global platforms and any new projects that comes into development.
The Global Digital Library content and resources are developed to be platform agnostic and usable in different contexts.
The API allows you to retrieve the structure and content of the books on the site using conventional HTTP requests with no credentials or authentication required. Below is an overview of the available endpoints, the arguments that can be passed and excerpts of the responses these endpoints will return.
All content elements are marked with specific Creative Commons license.
{
"books": [
{
"postId": 35879,
"title": "Where the River Monster Roams",
"description": "Somenea wants to see the creature in the river very badly. She prepares a lookout to spot the creature, but what will she find? Is it what she expects?",
"topicCategory": [],
"post_type": "book",
"post_name": "where-the-river-monster-roams",
...
],
"meta": {
"count": 10,
"limit": 20,
"skip": null,
"q": {
"contenttype": "h5p"
}
},
"args": {
"language": "en",
"s": "monster",
"offset": null,
"post_type": "book",
"suppress_filters": false,
"orderby": "relevance",
"order": "DESC",
"tax_query": [
{
"taxonomy": "resource-type",
"field": "slug",
"terms": "book"
}
],
"posts_per_page": 20
}
}[
{
"term_id": 1641,
"name": "Afrikaans",
"slug": "af",
"term_group": 0,
"term_taxonomy_id": 287,
"taxonomy": "language",
"description": "Language category for Afrikaans",
"parent": 0,
"count": 30,
"filter": "raw",
"term_order": "0"
},
...
}{
"books": [
{
"postId": 38843,
"title": "The Lost Doll",
"description": "",
"topicCategory": [],
"post_type": "book",
"post_name": "the-lost-doll-2",
"postLink": "https:\/\/digitallibrary.io\/en\/book\/the-lost-doll-2\/",
"lastChanged": "2023-08-29 15:30:43",
"h5pId": "15434",
"h5pUrl": "https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/exports\/the-lost-doll-10-15434.h5p",
"epubUrl": "",
"downloadPdfLocalURL": "",
"mainCategory": [],
"topic": [
{
"term_id": 1943,
"name": "Emergent Readers",
"slug": "emergent-readers",
"term_group": 0,
"term_taxonomy_id": 589,
"taxonomy": "topic",
"description": "",
"parent": 1910,
"count": 281,
"filter": "raw",
"term_order": "1"
},
{
"term_id": 1910,
"name": "Library Books",
"slug": "library-books",
"term_group": 0,
"term_taxonomy_id": 556,
"taxonomy": "topic",
"description": "Books across different reading levels.",
"parent": 0,
"count": 6902,
"filter": "raw",
"term_order": "4"
}
],
"collectionTag": [],
"thumbnail": "https:\/\/digitallibrary.io\/wp-content\/uploads\/2023\/08\/Skjermbilde-2023-08-29-kl.-15.27.57.png",
"publisher": "",
"contentsource": "",
"language": [
{
"term_id": 1523,
"name": "English",
"slug": "en",
"term_group": 0,
"term_taxonomy_id": 169,
"taxonomy": "language",
"description": "",
"parent": 0,
"count": 2188,
"filter": "raw",
"term_order": "0"
}
],
"level": [],
"license": [],
"bookId": "",
"h5pFiles": [
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/coverImage.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-00cdfac876bad5df3a1e470b546de7f6.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-103ad0ef0178238975996f8147c9ce34.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-1088b6d732161819888481bc20863e7c.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-1ce0e999d2f96c6d254c2de8d763318a.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-1dd8bab4fb44379a9e7e38ff1ec1a2e3.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-1fc1f7b16bfeb9b61930947913d6af49.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-25103fdb1810a35fafb68db92fb882c6.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-2602d714b18cee71b1757e6ddf12f09a.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-57464e3f3b1629749050bfecfd7ab960.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-5c2a598a19051fbd1073cfddb321f159.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-7d070eb2c6335be9e2abd9c8412e1a37.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-877c4a5b12788327b7c0002210ad8d88.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-90ea2355490893a194a78bc7e734f41d.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-a3ff5065036f1204d0f40888bb098d40.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-cb71908c956497d514415ad3f483df79.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-ccbdd2eed34d1aa4c93b39b079bfa9f1.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-d27f2ea888c9e6722399744f3408498c.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-d2d9481571863f5901beaed29f539911.jpg",
"https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/file-e46b76ff10334525c8e015bea7ae944a.jpg"
]
},
...{
"games": [
{
"postId": 38733,
"title": "Add to 5",
"topicCategory": [],
"post_type": "book",
"post_name": "add-to-5",
"description": "",
"h5pId": "15390",
"h5pUrl": "https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/exports\/addition-to-5-15390.h5p",
"mainCategory": [],
"topic": [
{
"term_id": 1642,
"name": "Collections",
"slug": "collections",
"term_group": 0,
"term_taxonomy_id": 288,
"taxonomy": "topic",
"description": "Fun collections of books and games",
"parent": 0,
"count": 90,
"filter": "raw",
"term_order": "2"
},
{
"term_id": 2320,
"name": "Test",
"slug": "test",
"term_group": 0,
"term_taxonomy_id": 966,
"taxonomy": "topic",
"description": "",
"parent": 1642,
"count": 36,
"filter": "raw",
"term_order": "0"
}
],
"lastChanged": "2023-08-09 21:59:40",
"resourceSubCategory": [],
"collectionTag": [],
"thumbnail": "https:\/\/digitallibrary.io\/wp-content\/uploads\/2022\/03\/Numbers-1-\u2013-5.-Image-Sequencing.png",
"publisher": "",
"language": [
{
"term_id": 1523,
"name": "English",
"slug": "en",
"term_group": 0,
"term_taxonomy_id": 169,
"taxonomy": "language",
"description": "",
"parent": 0,
"count": 2188,
"filter": "raw",
"term_order": "0"
}
],
"level": [],
"license": [
{
"term_id": 1578,
"name": "CC-BY-4.0",
"slug": "cc-by-4-0",
"term_group": 0,
"term_taxonomy_id": 224,
"taxonomy": "license",
"description": "",
"parent": 0,
"count": 8562,
"filter": "raw",
"term_order": "0"
}
],
"h5pLibrary": {
"id": "35",
"name": "H5P.SingleChoiceSet",
"majorVersion": "1",
"minorVersion": "11",
"embedTypes": "iframe",
"fullscreen": "0"
},
"h5pFiles": [],
"h5pContent": "addition-to-5"
},
...[
{
"id": 2190,
"slug": "1-digit-division",
"name": "1-digit division",
"description": "",
"count": 1,
"image": "https:\/\/digitallibrary.io\/wp-content\/uploads\/2022\/12\/1-digit-division.png",
"parentCategory": "intro-to-division",
"featuredH5PId": "",
"h5pUrl": "",
"sequence": 8,
"topicAchievementId": "28264",
"levelUpUrl": "\/book\/level-up-1-digit-division\/?topic=division-intro&play=1",
"layout": "learnAndPractice"
},
{
"id": 2157,
"slug": "1-digit-multiplication",
"name": "1-digit multiplication",
"description": "",
"count": 0,
"image": "https:\/\/digitallibrary.io\/wp-content\/uploads\/2022\/12\/02_TopicIllustration_1-digitMultiplication.png",
"parentCategory": "grade-3",
"featuredH5PId": "",
"h5pUrl": "",
"sequence": 2,
"topicAchievementId": "",
"levelUpUrl": "",
"layout": "listAll"
},
...
}[
{
"term_id": 1959,
"name": "Classroom Books",
"slug": "classroom-books",
"term_group": 0,
"term_taxonomy_id": 605,
"taxonomy": "topic",
"description": "Books for schools",
"parent": 0,
"count": 2557,
"filter": "raw",
"term_order": "0",
"sequenceOrder": 999,
"slugPath": "\/topic\/classroom-books\/",
"level": 0,
"children": [
{
"term_id": 1960,
"name": "Decodable",
"slug": "decodable-classroom",
"term_group": 0,
"term_taxonomy_id": 606,
"taxonomy": "topic",
"description": "Decodable books for emergent readers",
"parent": 1959,
"count": 659,
"filter": "raw",
"term_order": "0",
"sequenceOrder": 999,
"slugPath": "\/topic\/classroom-books\/decodable-classroom\/",
"level": 1,
"children": []
},
...[
{
"term_id": 1642,
"name": "Collections",
"slug": "collections",
"term_group": 0,
"term_taxonomy_id": 288,
"taxonomy": "topic",
"description": "Fun collections of books and games",
"parent": 0,
"count": 90,
"filter": "raw",
"term_order": "2",
"sequenceOrder": 999,
"slugPath": "\/topic\/collections\/",
"level": 0,
"children": [
{
"term_id": 1929,
"name": "Animals",
"slug": "animals",
"term_group": 0,
"term_taxonomy_id": 575,
"taxonomy": "topic",
"description": "",
"parent": 1642,
"count": 52,
"filter": "raw",
"term_order": "3",
"sequenceOrder": 999,
"slugPath": "\/topic\/collections\/animals\/",
"level": 1,
"children": [],
"postCount": 5,
"resources": [
36266,
36059,
36005,
35995,
35991
]
},
...{
"showCoverPage": false,
"bookCover": {
"coverDescription": "<p style=\"text-align: center;\"><\/p>",
"coverMedium": {
"params": {}
}
},
"chapters": [
{
"params": {
"content": [
{
"content": {
"params": {
...epub file (binary)[
{
"bookId": 38843,
"title": "The Lost Doll",
"bookPostTitle": "The Lost Doll",
"h5pTitle": "The Lost Doll",
"description": "Abi loves her doll very much, but one day it goes missing. What will she do?",
"bookPostDescription": "",
"h5pDescription": "Abi loves her doll very much, but one day it goes missing. What will she do?",
"coverImagePost": {
"url": "https:\/\/digitallibrary.io\/wp-content\/uploads\/2023\/08\/Skjermbilde-2023-08-29-kl.-15.27.57.png",
"alt": "",
"title": "Skjermbilde 2023-08-29 kl. 15.27.57"
},
"coverImage": {
"url": "https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/coverImage.jpg",
"alt": "Girl holding doll.",
"title": ""
},
"coverImageH5P": {
"url": "https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/coverImage.jpg",
"alt": "Girl holding doll.",
"title": ""
},
"language": [
{
"term_id": 1523,
"name": "English",
"slug": "en",
"term_group": 0,
"term_taxonomy_id": 169,
"taxonomy": "language",
"description": "",
"parent": 0,
"count": 2188,
"filter": "raw",
"term_order": "0"
}
],
...{
"status": "200",
"response": "Ok",
"data": [
{
"bookId": 38843,
"title": "The Lost Doll",
"bookPostTitle": "The Lost Doll",
"h5pTitle": "The Lost Doll",
"description": "Abi loves her doll very much, but one day it goes missing. What will she do?",
"bookPostDescription": "",
"h5pDescription": "Abi loves her doll very much, but one day it goes missing. What will she do?",
"coverImagePost": {
"url": "https:\/\/digitallibrary.io\/wp-content\/uploads\/2023\/08\/Skjermbilde-2023-08-29-kl.-15.27.57.png",
"alt": "",
"title": "Skjermbilde 2023-08-29 kl. 15.27.57"
},
"coverImage": {
"url": "https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/coverImage.jpg",
"alt": "Girl holding doll.",
"title": ""
},
"coverImageH5P": {
"url": "https:\/\/digitallibrary.io\/wp-content\/uploads\/h5p\/content\/15434\/images\/coverImage.jpg",
"alt": "Girl holding doll.",
"title": ""
},
"language": [
{
"term_id": 1523,
"name": "English",
"slug": "en",
"term_group": 0,
"term_taxonomy_id": 169,
"taxonomy": "language",
"description": "",
"parent": 0,
"count": 2188,
"filter": "raw",
"term_order": "0"
}
],
...