Docs / Endpoints

Endpoints

Every route the RapidEye API serves, with request and response shapes.

Create a key

POST/v1/signupNo auth

Issues a free developer key and emails a copy.

BodyTypeNotes
email requiredstringWhere the key copy is sent.
curl -X POST https://api.rapideyeinspections.com/v1/signup \
  -H "content-type: application/json" -d '{"email":"you@company.com"}'

200 { "key": "re_...", "next": [ ...three next steps... ] }

Inspect your key

GET/v1/meBearer

Returns the account behind the key and which platforms are connected to it. Credentials are never returned.

curl https://api.rapideyeinspections.com/v1/me -H "Authorization: Bearer re_..."

200 { "email": "you@company.com", "created": "2026-07-25T20:34:51.989Z",
      "connections": ["hostaway"] }

Connect a platform

POST/v1/connections/{platform}Bearer

Stores that platform's credentials against your key, sealed with AES-GCM. Fields differ per platform; see Authentication.

curl -X POST https://api.rapideyeinspections.com/v1/connections/pricelabs \
  -H "Authorization: Bearer re_..." -H "content-type: application/json" \
  -d '{"apiKey":"..."}'

200 { "connected": "pricelabs", "note": "You can now call /v1/pricelabs/..." }

Call a platform

ANY/v1/{platform}/{...path}Bearer

Pass-through to the platform API. Whatever that platform documents, this serves; the method, query string, and request body are forwarded unchanged, and the platform's authentication is injected for you. Swap the platform's host for api.rapideyeinspections.com/v1/{platform} and keep the rest of the path.

# Hostaway: api.hostaway.com/v1/listings becomes
curl https://api.rapideyeinspections.com/v1/hostaway/listings \
  -H "Authorization: Bearer re_..."

# responses carry the upstream body plus:
x-rapideye-platform: hostaway

Platforms marked request_access return 403 with a booking link instead of proxying. See Errors.

Discovery

GET/No auth

Machine-readable index: every route, every platform, and each platform's status and credential fields. This is the endpoint an agent should read first.

GET/llms.txtNo auth

Plain-text quickstart written for agents rather than people.