Maps
Maps describe published destinations and the content that belongs to them. Set BASE_URL as shown in the API overview before running these examples.
Get a map
Section titled “Get a map”GET /maps/:map_id
Returns a map and the requested related sections. Each section flag is passed as a string; use true to request it.
| Parameter | In | Required | Description |
|---|---|---|---|
map_id | Path | Yes | Map UUID. |
info | Query | No | Include map information. |
all_categories | Query | No | Include all categories. |
categories | Query | No | Include categories. |
markers | Query | No | Include markers. |
paths | Query | No | Include paths. |
polygons | Query | No | Include polygons. |
publisher | Query | No | Include publisher data. |
map_data | Query | No | Include map data. |
contact | Query | No | Include contact data. |
map_sponsors | Query | No | Include map sponsors. |
version_id | Query | No | Return content from this map-version UUID. |
tag_counts | Query | No | Include tag counts. |
contents | Query | No | Include map content blocks. |
curl --get "$BASE_URL/maps/11111111-1111-4111-8111-111111111111" \ --data-urlencode "info=true" \ --data-urlencode "categories=true" \ --data-urlencode "publisher=true"Get map details
Section titled “Get map details”GET /maps/:map_id/details
Returns identity and presentation details for one map. This endpoint can also return the limited identity and branding needed to represent a disabled map.
| Parameter | In | Required | Description |
|---|---|---|---|
map_id | Path | Yes | Map UUID. |
curl "$BASE_URL/maps/11111111-1111-4111-8111-111111111111/details"Get map contents
Section titled “Get map contents”GET /maps/:map_id/contents
Returns the content blocks associated with a map.
| Parameter | In | Required | Description |
|---|---|---|---|
map_id | Path | Yes | Map UUID. |
curl "$BASE_URL/maps/11111111-1111-4111-8111-111111111111/contents"Publishers
Section titled “Publishers”Publishers are the destination organizations that maintain maps and their content.
Get a publisher
Section titled “Get a publisher”GET /publisher/:publisher_id
Returns one publisher by ID.
| Parameter | In | Required | Description |
|---|---|---|---|
publisher_id | Path | Yes | Publisher UUID. |
curl "$BASE_URL/publisher/33333333-3333-4333-8333-333333333333"List a publisher’s maps
Section titled “List a publisher’s maps”GET /publisher/:publisher_id/maps
Returns the published maps maintained by one publisher. You can provide a coordinate to order them by proximity.
| Parameter | In | Required | Description |
|---|---|---|---|
publisher_id | Path | Yes | Publisher UUID. |
lng | Query | No | Longitude used with lat. |
lat | Query | No | Latitude used with lng. |
curl --get "$BASE_URL/publisher/33333333-3333-4333-8333-333333333333/maps" \ --data-urlencode "lat=40.7128" \ --data-urlencode "lng=-74.0060"