List or search locations

get

https://platform.reactvision.xyz/functions/v1/vps/locations

Client or secret key. Scope: vps.

Also accepts a user token.

Without lat and lon: every location the request can see, newest first, a page at a time, each with a summary of its active scan. Pass next_cursor as cursor for the next page; it is null on the last.

With lat and lon: the placed locations within radius_m of the point, nearest first, each with distance_m. lat and lon go together: a blank or lone one, or one out of range, answers 400 INVALID_BODY. Finding a place by a camera image, without a GPS fix, is the VPS server's image search.

A client or legacy key sees the project's shared locations only. A secret key sees every location of the project, or, with x-app-user-id, that app user's and the shared ones; a user token sees its app user's and the shared ones.

Not counted against the monthly API request quota.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

lat

number

-90 to 90

Latitude of the search centre, -90 to 90. Send it with lon to search near a point.

lon

number

-180 to 180

Longitude of the search centre, -180 to 180.

radius_m

number

≤ 5000

Defaults to 200

With lat and lon: search radius in metres, up to 5,000. Default 200.

limit

integer

1 to 100

Most results: 1 to 100. Default 50 for the list, 20 for a search near a point.

cursor

string

The previous page's next_cursor. Left out, the first page.

Headers

x-project-id

uuid

required

The project. With a client key or a bound secret key, the key's own project; with a user token, the token's project.

x-app-user-id

string

length between 1 and 255

Your id for the signed-in app user: 1 to 255 printable ASCII characters, no spaces, not . or ... With a secret key, the request acts for that app user: it sees the app user's locations and scans and the shared ones, and changes only the app user's own. With a user token, leave it out or send the token's own app user; another one answers 403 APP_USER_MISMATCH. A client or legacy key cannot send it (403 APP_USER_ID_NOT_ALLOWED).

Responses

`MISSING_PROJECT_ID`: no `x-project-id` header.

`INVALID_PROJECT_ID`: `x-project-id` is not a UUID.

`INVALID_APP_USER_ID`: `x-app-user-id` is not 1 to 255 printable ASCII characters without spaces, or is `.` or `..`.

`INVALID_BODY`: `lat` or `lon` is blank, alone or out of range, or `cursor` is not one this API issued.

`BAD_REQUEST`: `limit` or `radius_m` is out of range.

List or search locations

`RATE_LIMITED`: for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in `Retry-After`. See Limits.

`INTERNAL_ERROR`: an unexpected error. Retry, and quote `meta.request_id` to support if it persists.

`AUTH_UNAVAILABLE`: the key or user token could not be checked. Retry; this does not mean it is invalid.

`VPS_LOOKUP_FAILED`: the records could not be read or written. Retry.

200A page of locations, or the locations near the point.

429RATE_LIMITED: for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in Retry-After. See Limits.

500INTERNAL_ERROR: an unexpected error. Retry, and quote meta.request_id to support if it persists.

503AUTH_UNAVAILABLE: the key or user token could not be checked. Retry; this does not mean it is invalid. VPS_LOOKUP_FAILED: the records could not be read or written. Retry.

`RATE_LIMITED`: for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in `Retry-After`. See Limits.

`INTERNAL_ERROR`: an unexpected error. Retry, and quote `meta.request_id` to support if it persists.

`AUTH_UNAVAILABLE`: the key or user token could not be checked. Retry; this does not mean it is invalid.

`VPS_LOOKUP_FAILED`: the records could not be read or written. Retry.