​
Error schema

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by type.

​
validation_error

  • Status: 400
  • Message: We found an error with one or more fields in the request.
  • Suggested action: The message will contain more details about what field and error were found.

​
missing_api_key

  • Status: 401
  • Message: Missing API key in the authorization header.
  • Suggested action: Include the following header in the request: Authorization: Basic username:.

​
subscription_past_due

  • Status: 402
  • Message: TODO:
  • Suggested action: TODO:

​
invalid_api_key

  • Status: 403
  • Message: API key is invalid.
  • Suggested action: Make sure the API key is correct or generate a new API key in the dashboard.

​
rate_limit_exceeded

  • Status: 429
  • Message: Too many request

​
coins_exceeded

  • Status: 429
  • Message: TODO:
  • Suggested action: TODO:

​
server_internal_error

  • Status: 500
  • Message: An unexpected error occurred.