Rates SpotBOOKING PLATFORM
Developer Portal

API Documentation

Complete API reference with interactive examples, live testing, and comprehensive guides.

API Reference
Browse all available endpoints

Quick Links

Authentication GuideError CodesRate Limits
Authentication Guide

API Key Authentication

Include your API key in the Authorization header as a Bearer token.

Authorization: Bearer pk_live_your_api_key_here
Key Types:
Sandbox

Keys starting with pk_test_ for development

Production

Keys starting with pk_live_ for production

POST/auth/token
Generate Access Token
Generate a new access token using client credentials or refresh token

Authentication

client_credentials

Base URL

https://api.example.com/v1
HTTP Status Codes
Complete reference of all possible HTTP status codes returned by the API
200
OK

Request successful

success
201
Created

Resource created successfully

success
400
Bad Request

Invalid request parameters or malformed JSON

client
401
Unauthorized

Missing, invalid, or expired authentication token

client
403
Forbidden

Insufficient permissions to access resource

client
404
Not Found

Requested resource does not exist

client
409
Conflict

Resource conflict (e.g., booking already exists)

client
422
Unprocessable Entity

Request valid but contains semantic errors

client
429
Too Many Requests

Rate limit exceeded

client
500
Internal Server Error

Unexpected server error

server
502
Bad Gateway

Invalid response from upstream server

server
503
Service Unavailable

Service temporarily unavailable

server
Rate Limits

Rate Limiting Policy

API requests are limited based on your subscription plan and API key type.

Sandbox

1,000

requests per hour

Staging

5,000

requests per hour

Production

10,000

requests per hour

Rate Limit Headers
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200