HomeGuidesAPI ReferenceChangelogDiscussions
Hire a ReactVision Expert 🛠️Launch Studio 🖥️Sponsor on GitHub ❤️Log In
API Reference

Find nearby cloud anchors

Client or secret key.

Finds the anchors of a project within radius meters of a point, nearest first. Only anchors created with both latitude and longitude can be found.

A client key gets at most 50 results within at most 1,000 m, public anchors only, and no external_user_id. Other keys get private anchors too, and at most 100 results within at most 5,000 m once those bounds are enforced (see Limits). A larger limit or radius is reduced without an error; search.radius_meters shows the radius used.

Counts as one request against the team's monthly API request quota, including a request that then fails a check.

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

Project to search. With a client key the project must be the key's own project.

number
required
-90 to 90

Latitude of the search centre, -90 to 90.

number
required
-180 to 180

Longitude of the search centre, -180 to 180.

number
≥ 1
Defaults to 500

Search radius, in meters. Default 500, minimum 1. Client keys: at most 1,000. Other keys: at most 5,000 once enforced. A larger value is reduced to the bound.

integer
≥ 1
Defaults to 50

Most results. Default 50, minimum 1. Client keys: at most 50. Other keys: at most 100 once enforced.

Responses

MISSING_PROJECT_ID: no project_id.

MISSING_COORDINATES: lat or lng is missing or not a number.

INVALID_LATITUDE: lat is outside -90 to 90.

INVALID_LONGITUDE: lng is outside -180 to 180.

MISSING_API_KEY: no x-api-key header.

INVALID_API_KEY_FORMAT: the key is not rv_live_, rv_client_ or rv_secret_ followed by 64 lowercase hexadecimal characters.

INVALID_API_KEY: no such key, or a key sent with the wrong prefix for its type.

API_KEY_EXPIRED: the key is past its expiry date.

AUTH_ERROR: a user token (rv_ut_) was sent as a Bearer token. This operation does not accept user tokens.

PROJECT_NOT_FOUND: project_id does not exist, belongs to another team, or is not the project the key is bound to. The three answers are the same.

API_REQUEST_LIMIT_REACHED: the team's monthly API request quota is used up.

RATE_LIMITED: more than 600 a minute from one IP address; or, for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in Retry-After. See Limits.

NEARBY_SEARCH_FAILED: the search failed.

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

API_KEY_LOOKUP_FAILED: the key could not be checked. Retry; this does not mean the key is invalid.

PROJECT_LOOKUP_FAILED: the project could not be checked. Retry.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json