COLBYOS · DEVELOPERS
API documentation
Property reports and location insights for your tools.
OpenAPI JSON ↗Browse endpoints ↓Guides
Quickstart
Create a key in your account. Find a listing with /availability or /suggestions, then call /quote with the operation and its parameters. To run the report, send those parameters with access_quote set to quote_token and deliberate_action: true.
Authentication
Send Authorization: Bearer <API_KEY> and Content-Type: application/json. Keep keys in server secrets, never URLs or logs. Try It sends your key directly to ColbyOS and keeps it only until you leave or reload the page. Preview the cost, then choose Run.
Credits & reuse
Discovery and quotes are free. Property reports cost 1 credit, or are free while tracked. Quote location reports for the first-page price; extra pages cost 1 credit each. Exact successful requests are free to repeat for 30 minutes across your account. Reuse does not extend expiry or unlock other endpoints. Responses include charged credits and remaining balance. Use the latest balance_revision; null means unavailable.
Pagination
Location reports include up to 18 competitors. For more, send next_cursor with the access_token and the same selection, including sort. Quote each page before running it. Property history continues with history_after_epoch from next_after_epoch. Expired continuations need a new quote and confirmation.
Errors & rate limits
Read error.code and keep request_id for support. The account policy is 60 requests per minute, shared across keys; on 429, follow Retry-After. Check your key for 401 and balance for 402. For expired quotes, unavailable data or an uncertain response, quote the same request before retrying. Recovery records prevent duplicate charges for seven days; this does not extend the 30-minute reuse window.
Data & coverage
Read each metric’s unit and coverage. Decimal values are strings; null is missing data, not zero. booking_share is the percentage of known bookings in the comparison group. Observation and publication dates show freshness. History contains recorded observations only and may be incomplete; there is no guaranteed refresh schedule.