{"_id":"5c660b7a77adf5002790cca2","category":"5c660b7a77adf5002790cc9c","isReference":false,"link_url":"","next":{"description":"","pages":[]},"title":"API Overview","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[]}},"githubsync":"","project":"5511df3be2990b0d00fb071d","slug":"getting-started","type":"basic","updates":[],"user":"5511dee39171e82b00897349","version":"5c660b7a77adf5002790ccc3","__v":19,"excerpt":"Welcome to the Astro Digital developer hub.","hidden":false,"order":0,"parentDoc":null,"sync_unique":"","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Introduction\"\n}\n[/block]\nAstro Digital Landmapper API helps to ingest Landmapper-BC data into the customer workflows. Landmapper-BC constellation is designed for persistent monitoring of lands with high-radiometric quality data. Due to that the main workflow of using the data is monitoring.\n\nThe API creates a subscription (or \"Task\") for monitoring of a given location and once a new image covering this location appears - the new data product (or \"Result\") is created.\n\nThe Area of Interested (AOI) is defined by MGRS 100km*100km cells (same as L1C Sentinel-2 products).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"\"\n}\n[/block]\n\n## Account Creation\nЕo get the most out of the service (like using [tasks](doc:tasks) and [results](doc:results) and keeping track of your published imagery), you will want to create an account. Please email help:::at:::astrodigital.com to provide an account Token for you.\n\n\n## Task creation\nWhen the location is defined it's possible to subscribe for an MGRS cell for monitoring. It's possible to define the range of dates and a cell for monitoring.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl 'https://api.astrodigital.com/v3.0/tasks' --data '{\\n  \\\"name\\\":\\\"Our Arugula Field\\\", \\t\\n  \\\"query\\\": {\\n    \\\"date_from\\\": \\\"2015-11-01\\\",\\n    \\\"date_to\\\": \\\"2016-01-01\\\",\\n    \\\"MGRS_cell\\\": \\\"10SGE\\\"\\n  }\\n}' -H 'Content-Type: application/json' -H 'Authorization: Token YOUR_TOKEN'\",\n      \"language\": \"curl\",\n      \"name\": \"request\"\n    },\n    {\n      \"code\": \"{\\n    \\\"id\\\":1,\\n    \\\"name\\\":\\\"My Alert\\\",\\n    \\\"created_at\\\":\\\"2016-01-27T15:24:03.126309Z\\\",\\n    \\\"updated_at\\\":\\\"2016-01-27T15:24:03.126335Z\\\",\\n    \\\"query\\\":{\\n        \\\"date_to\\\":\\\"2017-01-01\\\",\\n        \\\"MGRS_cell\\\": \\\"10SGE\\\"\\n        \\\"date_from\\\":\\\"2015-01-01\\\"\\n    },\\n    \\\"status\\\":\\\"ACTIVE\\\",\\n    \\\"status_time\\\":\\\"2016-01-27T15:24:03.126087Z\\\",\\n    \\\"expected_results\\\":20,\\n}\",\n      \"language\": \"json\",\n      \"name\": \"response\"\n    }\n  ]\n}\n[/block]\n## Check to see if you have new Results available\nNew imagery is currently added to the API as soon as it's downlinked in our station at Svalbard. In practice it means that the data will be avaliable within 6 hours. Below is an example of a request and response.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl 'https://api.astrodigital.com/v3.0/results' -H 'Authorization: Token YOUR_TOKEN'\",\n      \"language\": \"curl\",\n      \"name\": \"request\"\n    },\n    {\n      \"code\": \"{\\n    \\\"count\\\":1,\\n    \\\"next\\\":null,\\n    \\\"previous\\\":null,\\n    \\\"results\\\":[\\n        {\\n            \\\"id\\\":19,\\n            \\\"created_at\\\":\\\"2016-01-29T18:59:52.090109Z\\\",\\n            \\\"value\\\":{\\n                \\\"image_url\\\":\\\"https://s3-eu-west-1.amazonaws.com/ad-l0a-data/10SGE/2019-02-13/sensor1_E100_G5_2019-02-13_BC4_NadirIndia1.tiff\\\"\\n              \\t\\\"thumbnail_image_url\\\":\\\"https://s3-eu-west-1.amazonaws.com/ad-l0a-thumb/10SGE/2019-02-13/sensor1_E100_G5_2019-02-13_BC4_NadirIndia1_thumb.tiff\\\"\\n            },\\n            \\\"status\\\":\\\"COMPLETED\\\",\\n            \\\"status_time\\\":\\\"2016-01-29T18:59:52.101871Z\\\",\\n            \\\"is_ready\\\":true,\\n            \\\"task\\\":42\\n        }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"response\"\n    }\n  ]\n}\n[/block]","createdAt":"2015-10-06T19:27:56.731Z","link_external":false,"childrenPages":[]}

API Overview

Welcome to the Astro Digital developer hub.

[block:api-header] { "type": "basic", "title": "Introduction" } [/block] Astro Digital Landmapper API helps to ingest Landmapper-BC data into the customer workflows. Landmapper-BC constellation is designed for persistent monitoring of lands with high-radiometric quality data. Due to that the main workflow of using the data is monitoring. The API creates a subscription (or "Task") for monitoring of a given location and once a new image covering this location appears - the new data product (or "Result") is created. The Area of Interested (AOI) is defined by MGRS 100km*100km cells (same as L1C Sentinel-2 products). [block:api-header] { "type": "basic", "title": "" } [/block] ## Account Creation Еo get the most out of the service (like using [tasks](doc:tasks) and [results](doc:results) and keeping track of your published imagery), you will want to create an account. Please email help@astrodigital.com to provide an account Token for you. ## Task creation When the location is defined it's possible to subscribe for an MGRS cell for monitoring. It's possible to define the range of dates and a cell for monitoring. [block:code] { "codes": [ { "code": "curl 'https://api.astrodigital.com/v3.0/tasks' --data '{\n \"name\":\"Our Arugula Field\", \t\n \"query\": {\n \"date_from\": \"2015-11-01\",\n \"date_to\": \"2016-01-01\",\n \"MGRS_cell\": \"10SGE\"\n }\n}' -H 'Content-Type: application/json' -H 'Authorization: Token YOUR_TOKEN'", "language": "curl", "name": "request" }, { "code": "{\n \"id\":1,\n \"name\":\"My Alert\",\n \"created_at\":\"2016-01-27T15:24:03.126309Z\",\n \"updated_at\":\"2016-01-27T15:24:03.126335Z\",\n \"query\":{\n \"date_to\":\"2017-01-01\",\n \"MGRS_cell\": \"10SGE\"\n \"date_from\":\"2015-01-01\"\n },\n \"status\":\"ACTIVE\",\n \"status_time\":\"2016-01-27T15:24:03.126087Z\",\n \"expected_results\":20,\n}", "language": "json", "name": "response" } ] } [/block] ## Check to see if you have new Results available New imagery is currently added to the API as soon as it's downlinked in our station at Svalbard. In practice it means that the data will be avaliable within 6 hours. Below is an example of a request and response. [block:code] { "codes": [ { "code": "curl 'https://api.astrodigital.com/v3.0/results' -H 'Authorization: Token YOUR_TOKEN'", "language": "curl", "name": "request" }, { "code": "{\n \"count\":1,\n \"next\":null,\n \"previous\":null,\n \"results\":[\n {\n \"id\":19,\n \"created_at\":\"2016-01-29T18:59:52.090109Z\",\n \"value\":{\n \"image_url\":\"https://s3-eu-west-1.amazonaws.com/ad-l0a-data/10SGE/2019-02-13/sensor1_E100_G5_2019-02-13_BC4_NadirIndia1.tiff\"\n \t\"thumbnail_image_url\":\"https://s3-eu-west-1.amazonaws.com/ad-l0a-thumb/10SGE/2019-02-13/sensor1_E100_G5_2019-02-13_BC4_NadirIndia1_thumb.tiff\"\n },\n \"status\":\"COMPLETED\",\n \"status_time\":\"2016-01-29T18:59:52.101871Z\",\n \"is_ready\":true,\n \"task\":42\n }\n ]\n}", "language": "json", "name": "response" } ] } [/block]