For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer InformationAPI Reference
Developer InformationAPI Reference
  • Getting Started
    • Paradigm Overview
    • Onboarding
    • High-Level Notes
    • Authentication
      • Signing Requests
      • JSON-RPC over Websocket
    • Rate-Limits
    • Errors
    • Allowlisting URL`s
    • Security
  • Unified Markets
    • Summary
    • RFQ - Request For Quotes
    • OBv1
  • Delta-1 Spreads
    • Summary
    • High-Level Workflows
    • API Flows
  • What`s Changed
    • Auto-Populated Delta Hedge Quantity
    • Changes to Leg Level Validation
Logo
On this page
  • Auth Methods
  • Error Codes
Getting Started

Authentication

Previous

Signing Requests

Next
Built with

All Paradigm API endpoints are considered private and require authentication.

Paradigm uses token-based authentication for API access to both the RESToverHTTP and JSON-RPCoverWebSocket API endpoints.

As an additional protection measure against replay attacks in environments where SSL trust is not properly configured, Paradigm requires all RESToverHTTP requests to be signed using your Paradigm API Key’s <secret-key>.

Important Notes
  • Paradigm does not currently provide fine-grained token scopes or permissions. Please ensure your API credentials are stored securely.
  • If you have an IP whitelist set for your Venue API Keys, on the Venue, you will need to include Paradigm’s IP addresses in your Venue API Key whitelists.

Auth Methods

There are a number of Authentication methods available across both the RESToverHTTP and JSON-RPCoverWebSocket interfaces:

Only the <access-key> is needed for authenticating requests. The different methods are presented below in order of our preference.

HTTP Header
Cookie
Query Parameter

Authorization example with an HTTP Header

1{
2    "Authorization": "Bearer SXDlhLKYX6GH6InhBxcCzoW4"
3}

When possible, authentication should be performed using the Authorization HTTP header. The header should supply the Paradigm API <access-key> in plain text, preceded by the text “Bearer ”.

Authorization: Bearer <access-key>

Error Codes

The following error codes relate to Authentication Errors:

CodeMessageMeaning
401API Key is not enabled or has been revoked.Paradigm API Key is Inactive or has been Deleted.
401Invalid API Access Key.Paradigm API Access Key is invalid or incorrect.
403Request signature verification failed.Paradigm API Secret Key is invalid, incorrect or you have not properly created the signature.