{"_id":"5845aa2d9f79b51900b076a9","user":"5613e4f8fdd08f2b00437620","__v":0,"project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":38,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"category":{"_id":"58458b4fba4f1c0f009692bb","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-12-05T15:44:15.650Z","from_sync":false,"order":6,"slug":"datasets-hub","title":"DATASETS HUB"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-05T17:55:57.686Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":37,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Advance Access\",\n  \"body\": \"This feature is in our advance access program. This means that, while it is fully operational, it is subject to change.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"On this page:\",\n  \"body\": \"[Overview](#section-overview)\\n[Access the Datasets API](#section-access-the-datasets-api)\\n[Resources](#section-resources)\"\n}\n[/block]\n##Overview\nThe Datasets API is an HTTP API for programmatically [browsing](browse-datasets-via-the-datasets-api) and [querying](query-via-the-datasets-api) datasets based on metadata attributes. Metadata consists of **properties**, which describe each dataset’s **entities**, and their **values**. Learn more about [metadata for datasets](about-metadata-for-datasets).\n\nThe resulting data can be added to a CGC project for further analysis. Learn more about [accessing data from the Datasets API](access-data-from-the-datasets-api).\n\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##Access the Datasets API\n\nThe base path of the Datasets API is `https://cgc-datasets-api.sbgenomics.com/`.\n\nAll requests should have the following headers:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`Content-Type`\",\n    \"1-0\": \"`X-SBG-Auth-Token`\",\n    \"0-1\": \"Set this to `application/json`.\",\n    \"1-1\": \"Your [CGC authentication token](doc:get-your-authentication-token)\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##Resources\n* [Browse datasets via the Datasets API](doc:browse-datasets-via-the-datasets-api) \n* [Query via the Datasets API](doc:query-via-the-datasets-api) \n* [About metadata for datasets](doc:about-metadata-for-datasets) \n* [Access data from the Datasets API](doc:access-data-from-the-datasets-api) \n\n<div align=\"right\"><a href=\"#top\">top</a></div>","excerpt":"<a href=\"query-datasets\" style=\"color:#132c56\">QUERY DATASETS</a> > About the Datasets API","slug":"about-the-datasets-api","type":"basic","title":"About the Datasets API"}

About the Datasets API

<a href="query-datasets" style="color:#132c56">QUERY DATASETS</a> > About the Datasets API

[block:callout] { "type": "danger", "title": "Advance Access", "body": "This feature is in our advance access program. This means that, while it is fully operational, it is subject to change." } [/block] [block:callout] { "type": "warning", "title": "On this page:", "body": "[Overview](#section-overview)\n[Access the Datasets API](#section-access-the-datasets-api)\n[Resources](#section-resources)" } [/block] ##Overview The Datasets API is an HTTP API for programmatically [browsing](browse-datasets-via-the-datasets-api) and [querying](query-via-the-datasets-api) datasets based on metadata attributes. Metadata consists of **properties**, which describe each dataset’s **entities**, and their **values**. Learn more about [metadata for datasets](about-metadata-for-datasets). The resulting data can be added to a CGC project for further analysis. Learn more about [accessing data from the Datasets API](access-data-from-the-datasets-api). <div align="right"><a href="#top">top</a></div> ##Access the Datasets API The base path of the Datasets API is `https://cgc-datasets-api.sbgenomics.com/`. All requests should have the following headers: [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`Content-Type`", "1-0": "`X-SBG-Auth-Token`", "0-1": "Set this to `application/json`.", "1-1": "Your [CGC authentication token](doc:get-your-authentication-token)" }, "cols": 2, "rows": 2 } [/block] <div align="right"><a href="#top">top</a></div> ##Resources * [Browse datasets via the Datasets API](doc:browse-datasets-via-the-datasets-api) * [Query via the Datasets API](doc:query-via-the-datasets-api) * [About metadata for datasets](doc:about-metadata-for-datasets) * [Access data from the Datasets API](doc:access-data-from-the-datasets-api) <div align="right"><a href="#top">top</a></div>