Skip to main content
The Partner API is a REST API over HTTPS. All responses are JSON wrapped in a standard envelope.

Base URLs

Authentication

Every request authenticates with your partner API key (it starts with cr3d_) in the x-api-key header, never as Authorization: Bearer. Keep the key on your server. See Authentication for details.

Conventions

  • Envelope. Successful responses look like { "status": "success", "data": ... }.
  • Timestamps. All timestamps are ISO 8601 strings in UTC.
  • Errors. Failures return the appropriate HTTP status with { "statusCode", "message" }.
  • Rate limits. 120 requests / 60 seconds per API key. See Rate Limits.
Use the endpoints in the sidebar to explore parameters, schemas, and try requests interactively.