staticmap/v2/surveys/{surveyId}/{type}.{format}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the survey to retrieve content for as obtained from the coverage response. This will correspond to a specific date.

enum
required

Type of raster content to return. This corresponds to the requested types in the coverage end point.

Allowed:
enum
required

File format of the resulting raster image.

Allowed:
Query Params
string
required

The point for which the surveys are retrieved. The point is the longitude and latitude of the location on which to center the image, in the format LONG,LAT. For example, -74.044831,40.689669.

int64
required

Distance from the point in metres. Used in conjunction with point to define a bounding box (not a circle). Radius range between 1 - 100.

string
required

Size of the resultant image in pixels. It is the responsibility of the caller to maintain the aspect ratio of the requested image. The format is {width}x{height}, however only equal width and height values are currently supported. Maximum image size is "5000x5000".

string
required

Transaction token to use in an image request. This token is returned in the staticmap coverage response and contains the authentication information for the request. Multiple image requests made using the same transaction tokens do not incur additional usage costs within 30 days since the coverage call was made.

Responses

400

On bad input parameter.

403

transaction token is invalid.

429

Rate limit exceeded. Exponential backoff is recommended.Retry the request later.

503

Service is unavaiable due to overloaded.Exponential backoff is recommended. Retry the request later.

5XX

Internal server error.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
image/*