Parameter Examples
Parameters: since and until
In this example we retrieve surveys for a given polygon, since the 1st of Feb 2018 until 6 months ago for a location in Australia.
NOTE: For a location other than in Australia, for example in the US, substitute the LONG LAT values.
Request
https://api.nearmap.com/coverage/v2/poly/138.59707796614592,-34.91729448760797,138.61703360121672,-34.91729448760797,138.61703360121672,-34.927709974005474,138.59707796614592,-34.927709974005474,138.59707796614592,-34.91729448760797?apikey=<your AP key>&since=2018-02-01&until=6M\
Response
{
"surveys": [
{
"captureDate": "2018-04-19",
"firstPhotoTime": "2018-04-19T00:10:27Z",
"id": "100-510ace40-49b2-11e8-bb72-ff76fb415264",
"lastPhotoTime": "2018-04-19T03:35:45Z",
"location": {
"country": "AU",
"region": "Adelaide",
"state": "SA"
},
"onlineTime": "2018-04-27T00:31:24Z",
"pixelSize": 0.066,
"resources": {
"tiles": [
{
"id": "510ce2e8-49b2-11e8-bb75-cf2f2247d124",
"scale": 21,
"type": "Vert"
},
{
"id": "51100db0-49b2-11e8-bb79-170577ffc6a6",
"scale": 20,
"type": "East"
},
{
"id": "510f5294-49b2-11e8-bb78-ffe46b70e235",
"scale": 21,
"type": "South"
},
{
"id": "510e8e54-49b2-11e8-bb77-131ff6e28c7d",
"scale": 21,
"type": "North"
},
{
"id": "5110ee88-49b2-11e8-bb7a-bf00b6fd0bbd",
"scale": 20,
"type": "West"
}
]
},
"timezone": "ACST",
"utcOffset": 34200
},
{
"captureDate": "2018-02-26",
"firstPhotoTime": "2018-02-26T01:26:09Z",
"id": "100-2d147328-2028-11e8-896f-57ffd8ddb571",
"lastPhotoTime": "2018-02-26T05:06:56Z",
"location": {
"country": "AU",
"region": "Adelaide",
"state": "SA"
},
"onlineTime": "2018-03-05T03:49:16Z",
"pixelSize": 0.066,
"resources": {
"tiles": [
{
"id": "2d15d33a-2028-11e8-8972-ab630c07c403",
"scale": 21,
"type": "Vert"
}
]
},
"timezone": "ACDT",
"utcOffset": 37800
}
],
"limit": 20,
"offset": 0,
"total": 2
}
Parameter - sort
In this example we retrieve surveys for a given polygon, sorting the response fields according to the lastPhotoTime field in an ascending order , and limiting the response to three surveys for a location in Australia.
NOTE: For a location other than in Australia, for example in the US, substitute the LONG LAT values.
Request
https://api.nearmap.com/coverage/v2/poly/138.59707796614592,-34.91729448760797 ,138.61703360121672,-34.91729448760797,138.61703360121672,-34.927709974005474, 138.59707796614592,-34.927709974005474,138.59707796614592,-34.91729448760797 ?apikey=<your API key>&sort=lastPhotoTime&limit=3
Response
{
"surveys": [
{
"captureDate": "2009-10-19",
"firstPhotoTime": "2009-10-18T18:21:46Z",
"id": "100-c54f488e-b95d-11e7-bd8e-5f787b2dc397",
"lastPhotoTime": "2009-10-19T22:39:49Z",
"location": {
"country": "AU",
"region": "Adelaide",
"state": "SA"
},
"onlineTime": "2018-02-09T03:32:38Z",
"pixelSize": 0.08,
"resources": {
"tiles": [
{
"id": "c55168f8-b95d-11e7-bd91-43d8499f1906",
"scale": 21,
"type": "Vert"
}
]
},
"timezone": "ACDT",
"utcOffset": 37800
},
{
"captureDate": "2009-10-29",
"firstPhotoTime": "2009-10-28T15:52:19Z",
"id": "100-0647ec10-b95e-11e7-ac79-4fe499e7d4d3",
"lastPhotoTime": "2009-10-30T22:09:13Z",
"location": {
"country": "AU",
"region": "Adelaide",
"state": "SA"
},
"onlineTime": "2018-02-09T03:07:21Z",
"pixelSize": 0.08,
"resources": {
"tiles": [
{
"id": "064a0180-b95e-11e7-ac7c-2fae4102c9b7",
"scale": 21,
"type": "Vert"
}
]
},
"timezone": "ACDT",
"utcOffset": 37800
},
{
"captureDate": "2009-12-01",
"firstPhotoTime": "2009-11-30T16:03:36Z",
"id": "100-c735b188-b95d-11e7-bdec-8fc52cb7008c",
"lastPhotoTime": "2009-12-01T23:19:42Z",
"location": {
"country": "AU",
"region": "Adelaide",
"state": "SA"
},
"onlineTime": "2018-02-09T02:47:48Z",
"pixelSize": 0.08,
"resources": {
"tiles": [
{
"id": "c737c9a0-b95d-11e7-bdef-1f90b15ebb7e",
"scale": 21,
"type": "Vert"
}
]
},
"timezone": "ACDT",
"utcOffset": 37800
}
],
"limit": 3,
"offset": 0,
"total": 66
}
Parameter - fields
In this example we retrieve surveys for a given polygon, requesting only the captureDate and firstPhotoTime fields, and limiting the response to 10 surveys.
Request
https://api.nearmap.com/coverage/v2/poly/138.59707796614592,-34.91729448760797 ,138.61703360121672,-34.91729448760797,138.61703360121672,-34.927709974005474, 138.59707796614592,-34.927709974005474,138.59707796614592,-34.91729448760797 ?apikey=<your API key>&fields=id,captureDate&limit=10
Response
{
"surveys": [
{
"captureDate": "2018-10-29",
"firstPhotoTime": "2018-10-29T00:33:23Z",
"id": "100-353f704a-dcaa-11e8-b148-c715c343620e"
},
{
"captureDate": "2018-08-22",
"firstPhotoTime": "2018-08-22T00:17:33Z",
"id": "100-4c51ffe8-ab52-11e8-9b7a-b3f8ca0bcb81"
},
{
"captureDate": "2018-04-19",
"firstPhotoTime": "2018-04-19T00:10:27Z",
"id": "100-510ace40-49b2-11e8-bb72-ff76fb415264"
},
{
"captureDate": "2018-02-26",
"firstPhotoTime": "2018-02-26T01:26:09Z",
"id": "100-2d147328-2028-11e8-896f-57ffd8ddb571"
},
{
"captureDate": "2018-01-16",
"firstPhotoTime": "2018-01-15T22:36:22Z",
"id": "100-5b9060a6-04a1-11e8-a51e-d3d4da5bcad9"
},
{
"captureDate": "2017-11-21",
"firstPhotoTime": "2017-11-20T23:33:18Z",
"id": "100-8d0cfac6-d31a-11e7-b321-b3e831dd2b87"
},
{
"captureDate": "2017-10-02",
"firstPhotoTime": "2017-10-02T00:32:26Z",
"id": "100-ecc6b68e-b95f-11e7-92ea-17ff5cb53b71"
},
{
"captureDate": "2017-06-21",
"firstPhotoTime": "2017-06-21T02:05:25Z",
"id": "100-bfbe21ea-b95f-11e7-88df-632374f558b6"
},
{
"captureDate": "2017-05-09",
"firstPhotoTime": "2017-05-09T01:51:17Z",
"id": "100-ac6c05ee-b95f-11e7-84bb-cb4aa50875c6"
},
{
"captureDate": "2017-03-17",
"firstPhotoTime": "2017-03-16T23:17:20Z",
"id": "100-9aa1adfa-b95f-11e7-80d5-6b6ef8ac2f05"
}
],
"limit": 10,
"offset": 0,
"total": 66
}
Updated 6 months ago