How to authenticate your API requests

Authentication with API Key and JWT Token

To interact with Predict's API, you'll need two things:

API Key: Required for all endpoints (only on Mainnet).

JWT Token: Required for performing personal operations for a specific wallet (e.g., sending a new order or viewing active orders).

Sections:

Obtaining a JWT Token (for EOAs)

Obtaining a JWT Token (for Predict accounts)

Passing the API Key and JWT Token in the requests

Obtaining a JWT Token (for EOAs)

An API key is required to obtain a JWT token. Follow these steps to generate a JWT token for your wallet:

Retrieve the message to sign:
Send a GET request to /auth/message to retrieve a message for signing.

Sign the message with your wallet:
Use the wallet you want to authenticate with to sign the message retrieved in step 1.

Send the signature:
Send a POST request to /auth with the following JSON structure:

Obtaining a JWT Token (for Predict accounts)

This approach is only for users interracting on the web app via a social account. If you use an EOA (like MetaMask), see the EOAs guide.

An API key is required to obtain a JWT token. Follow these steps to generate a JWT token for your wallet:

Retrieve the message to sign:
Send a GET request to /auth/message to retrieve a message for signing.

Sign the message with your wallet via our SDK:
You will need two wallets:

Your Predict account address (aka deposit address)

Your Privy Wallet private key (can be exported from the account's settings)

NOTE: It's reccomended to fund with ETH your Privy Wallet to be able to set approvals and cancel orders.

Send the signature:
Send a POST request to /auth with the following JSON structure:

Passing the API Key and JWT Token in Requests

To authenticate your requests, you need to include both the API key and the JWT token in the request headers. The API key and x-api-key header are not required on Testnet.

Request headers (as shown on the example above):

{
  "headers": {
    "x-api-key": "YOUR_API_KEY",
    "Authorization": "Bearer YOUR_JWT_TOKEN"
  }
}

Example usage:

How to authenticate your API requests

Authentication with API Key and JWT Token#

Obtaining a JWT Token (for EOAs)#

Obtaining a JWT Token (for Predict accounts)#

Passing the API Key and JWT Token in Requests#

Authentication with API Key and JWT Token

Obtaining a JWT Token (for EOAs)

Obtaining a JWT Token (for Predict accounts)

Passing the API Key and JWT Token in Requests