Welcome

Welcome to Paradex API

Here you'll find all the documentation you need to get up and running with the Paradex API.

API Server Location

Our API server is located in the AWS AP-NORTHEAST-1 region (Tokyo).
The best way to synchronize your clock with our servers is via the Amazon time service.

Global IP Addresses

Paradex API leverages AWS Global Accelerator to route traffic to our infrastructure in Tokyo. It provides us with static IP addresses that are geographically distributed across the AWS global network.

These IP addresses may appear to be located in the US by some DNS lookup tools due to AWS being a US-based company. However, the actual path your traffic takes prioritizes the closest AWS edge location, ensuring efficient routing to our Tokyo infrastructure. This minimizes latency and delivers a smooth user experience regardless of your geographical location.

For a more in-depth explanation, check out the AWS Global Accelerator docs.

API URLs

Production


REST	`https://api.prod.paradex.trade/v1`
WebSocket	`wss://ws.api.prod.paradex.trade/v1`

Testnet


REST	`https://api.testnet.paradex.trade/v1`
WebSocket	`wss://ws.api.testnet.paradex.trade/v1`

Want to jump right in?

Feeling like an eager beaver? Jump in to the quick start docs to onboard yourself and send your first order.

Want to explore first?

Start with the REST API reference then jump to the WebSocket API to get real-time updates.

Quick start

Calling a public endpoint

import requests
headers = {'Accept': 'application/json'}
r = requests.get('https://api.testnet.paradex.trade/v1/markets', headers = headers)
print(r.json())

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/markets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
}

curl -X GET https://api.testnet.paradex.trade/v1/markets \
  -H 'Accept: application/json'

const headers = {
  Accept: "application/json",
};
fetch("https://api.testnet.paradex.trade/v1/markets", {
  method: "GET",
  headers: headers,
})
  .then((res) => {
    return res.json();
  })
  .then((body) => {
    console.log(body);
  });

To dive right in you can start by trying a call to one of Paradex's public endpoints, GET /markets.

The response will look something like this:

{
  "results": [
    {
      "symbol": "ETH-USD-PERP",
      "base_currency": "ETH",
      "quote_currency": "USD",
      "settlement_currency": "USDC",
      "order_size_increment": "0.001",
      "price_tick_size": "0.01",
      "open_at":0,
      "expiry_at":0,
      "asset_kind": "PERP",
    }
  ]
}

Interacting with private endpoints

To interact with private Paradex endpoints you need to onboard and generate a JSON Web Token (JWT) before making API requests. JWTs are a secure way to transmit information between parties. Please refer to the Authentication chapter and onboarding and authentication code samples.

Authentication

Your software will have to authenticate itself when:

You onboard your wallet using automatic onboarding code
You generate JWT (see below) for a private Rest API call or subscription to a private WebSocket
You send order to Paradex

What is JWT

Paradex uses JSON Web Tokens (JWTs) to authenticate users.

JWTs are a secure way to transmit information between parties as they are signed by the sender, which allows the recipient to verify the authenticity of the message.

For security reasons JWTs used in Paradex's authentication mechanism expire every 5 minutes. It is not possible to extend the expiration.

This means that users will need to re-authenticate regularly in order to always have a fresh JWT readily available.

Paradex recommends refreshing JWT well before expiry (e.g., after 3 minutes) to allow multiple retry attempts while still having a valid JWT.

This will help you to avoid interruptions in making REST API calls.

When using WebSocket connections, after the initial authentication, users do not need to re-authenticate again for the lifetime of the connection.

See more regarding Paradex JWT mechanism.

Benefits of Using JWT

The benefits of using JWT for authentication:

Security: JWTs are signed by the issuer, which allows the recipient to verify the authenticity of the message.
Efficiency: JWTs are small and lightweight, which makes them efficient to transmit over the network.

Rate Limits

1. API

1.1. Public Endpoints

The rate limit for all of our public API endpoints is set to a maximum of 200 requests per second or 1500 requests per minute per IP address.

Exceptions:

POST /onboarding & POST /auth: These endpoints have a shared rate limit of 50 requests per second or 600 requests per minute per IP address.

1.2. Private Endpoints (Per-account limits)

For our private API endpoints, the rate limit varies according to the specific endpoint:

POST /orders & DELETE /orders: These endpoints have a shared rate limit of 800 requests per second or 15000 requests per minute per account.
GET /*: All GET endpoints have a shared rate limit of 40 requests per second or 600 requests per minute per account.

For private end points the rate limits are per account and not per IP.

2. Websocket

2.1. Public Concurrent Connections

For public concurrent connections via our Websocket, the rate limit is set to a maximum of 20 connections per second or 600 connections per minute per IP address.

3. Open Orders Per Account

The rate limit for open orders per account is set to a maximum of 100 orders per market.

4. Position Limit

Please refer to Position Limit section

5. Common Questions

What algorithm do you use for rate limits?

Fixed Window Counter rate limiting
This technique uses a counter to track the number of requests made within a given time period (time time period begins after first request is received). When the counter reaches the maximum allowed number of requests, further requests are blocked until the next time period begins.

What if I hit requests per minute limit, how long is the cool down period?

In a real world scenario, the expected wait time is expected to be less since not all the requests will arrive at the same time, so we can say the wait time to reset the limit for 1 minute bucket is up to 1 minute.
If you have requests well distributed over the time and you send 201 requests per second (assuming rate limit per second would allow you to do that) you will hit the limit exactly at the end of the minute (at ~59 seconds). In this scenario you would be able to send other requests just 1 second.

Paradex REST API v1.80.6

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The following describe Paradex API. Bear in mind that this is still a work in progress so all feedback is welcome.

Account

Get account information

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/account', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/account", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/account \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/account',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /account

Respond with requester's account information

Parameters

Name	In	Type	Required	Description
subaccount_address	query	string	false	Subaccount address

Example responses

200 Response

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "account_value": "136285.06918911",
  "free_collateral": "73276.47229774",
  "initial_margin_requirement": "63008.59689218",
  "maintenance_margin_requirement": "31597.25239676",
  "margin_cushion": "104687.8167956",
  "seq_no": 1681471234972000000,
  "settlement_asset": "USDC",
  "status": "ACTIVE",
  "total_collateral": "123003.62047353",
  "updated_at": 1681471234972
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.AccountSummaryResponse
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

Return account info of current account

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/account/info', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/account/info", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/account/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/account/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /account/info

Example responses

200 Response

{
  "results": [
    {
      "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "created_at": 1681471234972,
      "derivation_path": "m/44'/9004'/0'/0/1",
      "isolated_market": "ETHUSD-PERP",
      "kind": "main",
      "parent_account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d",
      "public_key": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetAccountsInfoResponse

Get account profile information

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/account/profile', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/account/profile", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/account/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/account/profile',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /account/profile

Respond with requester's account information

Example responses

200 Response

{
  "is_username_private": true,
  "programs_eligibility": {
    "affiliate": "Pending",
    "fee": "True",
    "maker": "True",
    "referral": "False"
  },
  "referral_code": "cryptofox8",
  "referred_by": "maxDegen",
  "twitter": {
    "id": "string",
    "image_url": "string",
    "username": "string"
  },
  "username": "username"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.AccountProfileResp
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

Updates account profile fields

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.post('https://api.testnet.paradex.trade/v1/account/profile/referral_code', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.testnet.paradex.trade/v1/account/profile/referral_code", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X POST https://api.testnet.paradex.trade/v1/account/profile/referral_code \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/account/profile/referral_code',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /account/profile/referral_code

Respond with requester's account information

Example responses

200 Response

{
  "is_username_private": true,
  "programs_eligibility": {
    "affiliate": "Pending",
    "fee": "True",
    "maker": "True",
    "referral": "False"
  },
  "referral_code": "cryptofox8",
  "referred_by": "maxDegen",
  "twitter": {
    "id": "string",
    "image_url": "string",
    "username": "string"
  },
  "username": "username"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.AccountProfileResp
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

Updates account profile username fields

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.post('https://api.testnet.paradex.trade/v1/account/profile/username', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.testnet.paradex.trade/v1/account/profile/username", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X POST https://api.testnet.paradex.trade/v1/account/profile/username \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/account/profile/username',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /account/profile/username

Respond with requester's account information

Example responses

200 Response

{
  "is_username_private": true,
  "programs_eligibility": {
    "affiliate": "Pending",
    "fee": "True",
    "maker": "True",
    "referral": "False"
  },
  "referral_code": "cryptofox8",
  "referred_by": "maxDegen",
  "twitter": {
    "id": "string",
    "image_url": "string",
    "username": "string"
  },
  "username": "username"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.AccountProfileResp
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

List sub-accounts of current account

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/account/subaccounts', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/account/subaccounts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/account/subaccounts \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/account/subaccounts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /account/subaccounts

Respond with requester's list of sub-accounts

Example responses

200 Response

{
  "results": [
    {
      "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "created_at": 1681471234972,
      "derivation_path": "m/44'/9004'/0'/0/1",
      "isolated_market": "ETHUSD-PERP",
      "kind": "main",
      "parent_account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d",
      "public_key": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetSubAccountsResponse

List balances

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/balance', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/balance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/balance \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/balance',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /balance

Respond with requester's own balances

Example responses

200 Response

{
  "results": [
    {
      "last_updated_at": 1681462770114,
      "size": "123003.620",
      "token": "USDC"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetBalancesResp
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

List fills

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/fills', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/fills", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/fills \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/fills',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /fills

This API returns a list of matched orders (i.e. fills) that have been sent to chain for settlement.

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	Returns the ‘next’ paginated page.
end_at	query	integer	false	End Time (unix time millisecond)
market	query	string	false	none
page_size	query	integer	false	Limit the number of responses in the page
start_at	query	integer	false	Start Time (unix time millisecond)

Example responses

200 Response

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "client_id": "x1234",
      "created_at": 1681375176910,
      "fee": "7.56",
      "fee_currency": "USDC",
      "fill_type": "FILL",
      "id": "8615262148007718462",
      "liquidity": "TAKER",
      "market": "BTC-USD-PERP",
      "order_id": "1681462103821101699438490000",
      "price": "30000.12",
      "remaining_size": "0.5",
      "side": "BUY",
      "size": "0.5"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetFillsResp
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

Funding payments history

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/funding/payments', params={
  'market': 'BTC-USD-PERP'
}, headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/funding/payments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/funding/payments?market=BTC-USD-PERP \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/funding/payments?market=BTC-USD-PERP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /funding/payments

List funding payments made by/to the requester's account

Funding payments are periodic payments between traders to make the perpetual futures contract price is close to the index price.

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	Returns the ‘next’ paginated page.
end_at	query	integer	false	End Time (unix time millisecond)
market	query	string	true	Market for which funding payments are queried
page_size	query	integer	false	Limit the number of responses in the page
start_at	query	integer	false	Start Time (unix time millisecond)

Example responses

200 Response

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "created_at": 1681375481000,
      "fill_id": "8615262148007718462",
      "id": "1681375578221101699352320000",
      "index": "-2819.53434361",
      "market": "BTC-USD-PERP",
      "payment": "34.4490622"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.FundingHistoryResp
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

List open positions

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/positions', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/positions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/positions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/positions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /positions

Get all positions owned by current user

Example responses

200 Response

{
  "results": [
    {
      "average_entry_price": "29001.34",
      "average_entry_price_usd": "29001.34",
      "cached_funding_index": "1234.3",
      "cost": "-10005.4623",
      "cost_usd": "-10005.4623",
      "id": "1234234",
      "last_fill_id": "1234234",
      "last_updated_at": 1681493939981,
      "leverage": "string",
      "liquidation_price": "string",
      "market": "BTC-USD-PERP",
      "seq_no": 1681471234972000000,
      "side": "SHORT",
      "size": "-0.345",
      "status": "OPEN",
      "unrealized_funding_pnl": "12.234",
      "unrealized_pnl": "-123.23"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetPositionsResp

List tradebusts

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/tradebusts', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/tradebusts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/tradebusts \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/tradebusts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /tradebusts

Retrieves a list of tradebusts associated to the requester's account

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	Returns the ‘next’ paginated page.
end_at	query	integer	false	End Time (unix time millisecond)
page_size	query	integer	false	Limit the number of responses in the page
start_at	query	integer	false	Start Time (unix time millisecond)

Example responses

200 Response

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "busted_fill_id": "12342345",
      "created_at": 1681497002041
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetTradebustsResp
400	Bad Request	Bad Request	responses.ApiError

List transactions

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/transactions', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/transactions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/transactions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/transactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /transactions

Retrieves a list of transactions initiated by the user

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	Returns the ‘next’ paginated page.
end_at	query	integer	false	End Time (unix time millisecond)
page_size	query	integer	false	Limit the number of responses in the page
start_at	query	integer	false	Start Time (unix time millisecond)

Example responses

200 Response

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "completed_at": 0,
      "created_at": 0,
      "hash": "0x445c05d6bfb899e39338440d199971c4d7f4cde7878ed3888df3f716efb8df2",
      "id": "12342423",
      "state": "ACCEPTED_ON_L1",
      "type": "TRANSACTION_FILL"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetTransactionResponse
400	Bad Request	Bad Request	responses.ApiError

Algos

Get open algo orders

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/algo/orders', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/algo/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/algo/orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/algo/orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /algo/orders

Get current user all open algo orders

Example responses

200 Response

{
  "results": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512",
      "algo_type": "TWAP",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "created_at": 1681493746016,
      "end_at": 1681493746016,
      "id": "123456",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "remaining_size": "0",
      "side": "BUY",
      "size": "0.05",
      "status": "NEW"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetOpenAlgoOrders
400	Bad Request	Bad Request	responses.ApiError

Create algo order

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.post('https://api.testnet.paradex.trade/v1/algo/orders', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.testnet.paradex.trade/v1/algo/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X POST https://api.testnet.paradex.trade/v1/algo/orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'

const inputBody = '{
  "algo_type": "TWAP",
  "duration_seconds": 3600,
  "market": "BTC-USD-PERP",
  "side": "MARKET",
  "signature": "string",
  "signature_timestamp": 0,
  "size": "1.213",
  "type": "MARKET"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/algo/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /algo/orders

Open a new algo order

TWAP

TWAP orders break a large trade into smaller ones over time to reduce market impact: - Sub-orders are placed every 30 seconds. - Order duration is between 30 and 86,400 seconds, in multiples of 30. - Supported sub order type: MARKET

Body parameter

{
  "algo_type": "TWAP",
  "duration_seconds": 3600,
  "market": "BTC-USD-PERP",
  "side": "MARKET",
  "signature": "string",
  "signature_timestamp": 0,
  "size": "1.213",
  "type": "MARKET"
}

Parameters

Name	In	Type	Required	Description
body	body	requests.AlgoOrderRequest	true	Algo order content

Example responses

201 Response

{
  "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512",
  "algo_type": "TWAP",
  "avg_fill_price": "26000",
  "cancel_reason": "NOT_ENOUGH_MARGIN",
  "created_at": 1681493746016,
  "end_at": 1681493746016,
  "id": "123456",
  "last_updated_at": 1681493746016,
  "market": "BTC-USD-PERP",
  "remaining_size": "0",
  "side": "BUY",
  "size": "0.05",
  "status": "NEW"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	responses.AlgoOrderResp
400	Bad Request	Bad Request	responses.ApiError

Get algo orders history

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/algo/orders-history', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/algo/orders-history", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/algo/orders-history \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/algo/orders-history',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /algo/orders-history

Get current user algo orders filtered on attributes

Parameters

Name	In	Type	Required	Description
client_id	query	string	false	Unique ID of client generating the order
cursor	query	string	false	Returns the ‘next’ paginated page.
end_at	query	integer	false	End Time (unix time millisecond)
market	query	string	false	Market for the order
page_size	query	integer	false	Limit the number of responses in the page
side	query	string	false	Order side
start_at	query	integer	false	Start Time (unix time millisecond)
status	query	string	false	Order status
type	query	string	false	Order type

Enumerated Values

Parameter	Value
side	BUY
side	SELL
status	OPEN
status	CLOSED
status	NEW
type	LIMIT
type	MARKET
type	STOP_LIMIT
type	STOP_MARKET

Example responses

200 Response

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512",
      "algo_type": "TWAP",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "created_at": 1681493746016,
      "end_at": 1681493746016,
      "id": "123456",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "remaining_size": "0",
      "side": "BUY",
      "size": "0.05",
      "status": "NEW"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetAlgoOrders
400	Bad Request	Bad Request	responses.ApiError

Get algo order by id

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/algo/orders/{algo_id}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/algo/orders/{algo_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/algo/orders/{algo_id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/algo/orders/{algo_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /algo/orders/{algo_id}

Get an algo order by id. Only return algo order in OPEN or NEW status.

Parameters

Name	In	Type	Required	Description
algo_id	path	string	true	Algo ID

Example responses

200 Response

{
  "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512",
  "algo_type": "TWAP",
  "avg_fill_price": "26000",
  "cancel_reason": "NOT_ENOUGH_MARGIN",
  "created_at": 1681493746016,
  "end_at": 1681493746016,
  "id": "123456",
  "last_updated_at": 1681493746016,
  "market": "BTC-USD-PERP",
  "remaining_size": "0",
  "side": "BUY",
  "size": "0.05",
  "status": "NEW"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.AlgoOrderResp
404	Not Found	Not Found	responses.ApiError

Cancel algo order by id

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.delete('https://api.testnet.paradex.trade/v1/algo/orders/{algo_id}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.testnet.paradex.trade/v1/algo/orders/{algo_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X DELETE https://api.testnet.paradex.trade/v1/algo/orders/{algo_id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/algo/orders/{algo_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /algo/orders/{algo_id}

Cancel an existing algo order by id

Parameters

Name	In	Type	Required	Description
algo_id	path	string	true	Algo ID

Example responses

404 Response

{
  "data": null,
  "error": "NOT_ONBOARDED",
  "message": "User has never called /onboarding endpoint"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
404	Not Found	Not Found	responses.ApiError

Authentication

Get JWT

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'PARADEX-STARKNET-ACCOUNT': 'string',
  'PARADEX-STARKNET-SIGNATURE': 'string',
  'PARADEX-TIMESTAMP': 'string',
  'PARADEX-SIGNATURE-EXPIRATION': 'string'
}

r = requests.post('https://api.testnet.paradex.trade/v1/auth', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "PARADEX-STARKNET-ACCOUNT": []string{"string"},
        "PARADEX-STARKNET-SIGNATURE": []string{"string"},
        "PARADEX-TIMESTAMP": []string{"string"},
        "PARADEX-SIGNATURE-EXPIRATION": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.testnet.paradex.trade/v1/auth", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X POST https://api.testnet.paradex.trade/v1/auth \
  -H 'Accept: application/json' \
  -H 'PARADEX-STARKNET-ACCOUNT: string' \
  -H 'PARADEX-STARKNET-SIGNATURE: string' \
  -H 'PARADEX-TIMESTAMP: string' \
  -H 'PARADEX-SIGNATURE-EXPIRATION: string'


const headers = {
  'Accept':'application/json',
  'PARADEX-STARKNET-ACCOUNT':'string',
  'PARADEX-STARKNET-SIGNATURE':'string',
  'PARADEX-TIMESTAMP':'string',
  'PARADEX-SIGNATURE-EXPIRATION':'string'
};

fetch('https://api.testnet.paradex.trade/v1/auth',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth

Authenticate using signed payload to get a JWT for usage in other endpoints

There are multiple valid headers required to be sent as part of this request.

For onboarding examples, refer to go, java and python code in code-samples.

StarkNet Message Hash and Signature

Inspired by EIP-712, (a standard for hashing and signing typed structured data) the encoding of an off-chain message is defined as:

signed_data = Enc[PREFIX_MESSAGE, domain_separator, account, hash_struct(message)]

where:

PREFIX_MESSAGE = "StarkNet Message"
domain_separator is defined as the hash_struct of the StarkNetDomain struct:
- Struct contains: name, chainId and version
- chainId is can be obtained calling GET /system/config
account is the StarkNet account address
The message to be hashed is represented as a struct
- hash_struct(message) = Enc[type_hash(MyStruct), Enc[param1], ..., Enc[paramN]]
- where type_hash is defined as in EIP-712 (but using selector instead of keccak)
- More details on StarkNet - Hash Functions

In case of more complex structure of object, you have to work in the spirit of EIP-712. This json structure has 4 mandatory items: types, primaryType, domain and message. These items are designed to be able to be an interface with a wallet. At sign request, the wallet will display:

message will be displayed at the bottom of the wallet display, showing clearly (not in hex) the message to sign. Its structure has to be in accordance with the type listed in primaryType, defined in types.
domain will be shown above the message. Its structure has to be in accordance with StarkNetDomain.

The predefined types that you can use :

felt : for an integer on 251 bits.
felt* : for an array of felt.
string : for a shortString of 31 ASCII characters max.
selector : for a name of a smart contract function.
merkletree : for a Root of a Merkle tree, calculated with the provided data.

Specification details: Signing transactions and off-chain messages

Message Hash Sample Code

For a complete message_hash example, refer to python code in code-samples.

Examples:

{
  "paradex-signature-expiration": 1682364556,
  "paradex-starknet-account": "0x129f3dc1b8962d8a87abc692424c78fda963ade0e1cd17bf3d1c26f8d41ee7a",
  "paradex-starknet-signature": [
    "1381323390094460587764867648394252677239485992175346764030313478865763678671",
    "396490140510115262427678549757564216013606350105112805717359873954984880589"
  ],
  "paradex-timestamp": 1681759756
}

Parameters

Name	In	Type	Required	Description
PARADEX-STARKNET-ACCOUNT	header	string	true	Starknet account
PARADEX-STARKNET-SIGNATURE	header	string	true	Starknet signature
PARADEX-TIMESTAMP	header	string	true	Timestamp when the signature was created
PARADEX-SIGNATURE-EXPIRATION	header	string	false	Timestamp when signature expires (default 30 min

Example responses

200 Response

{
  "jwt_token": "eyJhbGciOiJFUzM4NCIsInR5cCI6IkpXVCJ9.eyJ0eXAiOiJhdCtKV1QiLCJleHAiOjE2ODE0NTI5MDcsImlhdCI6MTY4MTQ1MjYwNywiaXNzIjoiUGFyYWRleCBzdGFnaW5nIiwic3ViIjoiMHg0OTVkMmViNTIzNmExMmI4YjRhZDdkMzg0OWNlNmEyMDNjZTIxYzQzZjQ3M2MyNDhkZmQ1Y2U3MGQ5NDU0ZmEifQ.BPihIbGhnnsuPlReqC9x12JFXldpswg5EdA6tTiDQm-_UHaRz_8RfVBqWc2fPN6CzFsXTq7GowZu-2qMxPvZK_fGcxEhTp2k1r8MUxowlUIT4vPu2scCwrsyIujlCAwS"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.AuthResp
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

Onboarding

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'PARADEX-ETHEREUM-ACCOUNT': 'string',
  'PARADEX-STARKNET-ACCOUNT': 'string',
  'PARADEX-STARKNET-SIGNATURE': 'string'
}

r = requests.post('https://api.testnet.paradex.trade/v1/onboarding', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "PARADEX-ETHEREUM-ACCOUNT": []string{"string"},
        "PARADEX-STARKNET-ACCOUNT": []string{"string"},
        "PARADEX-STARKNET-SIGNATURE": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.testnet.paradex.trade/v1/onboarding", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X POST https://api.testnet.paradex.trade/v1/onboarding \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'PARADEX-ETHEREUM-ACCOUNT: string' \
  -H 'PARADEX-STARKNET-ACCOUNT: string' \
  -H 'PARADEX-STARKNET-SIGNATURE: string'

const inputBody = '{
  "public_key": "0x3d9f2b2e5f50c1aade60ca540368cd7490160f41270c192c05729fe35b656a9",
  "referral_code": "cryptofox8"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'PARADEX-ETHEREUM-ACCOUNT':'string',
  'PARADEX-STARKNET-ACCOUNT':'string',
  'PARADEX-STARKNET-SIGNATURE':'string'
};

fetch('https://api.testnet.paradex.trade/v1/onboarding',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /onboarding

Onboarding verifies that the caller owns the StarkNet address and enters them into the database. This call is idempotent.

Body parameter

{
  "public_key": "0x3d9f2b2e5f50c1aade60ca540368cd7490160f41270c192c05729fe35b656a9",
  "referral_code": "cryptofox8"
}

Parameters

Name	In	Type	Required	Description
PARADEX-ETHEREUM-ACCOUNT	header	string	true	Ethereum account used to onboard
PARADEX-STARKNET-ACCOUNT	header	string	true	Starknet address
PARADEX-STARKNET-SIGNATURE	header	string	true	Starknet signature
body	body	requests.Onboarding	true	Onboarding user public_key

Example responses

400 Response

{
  "data": null,
  "error": "NOT_ONBOARDED",
  "message": "User has never called /onboarding endpoint"
}

Responses

Status	Meaning	Description	Schema
200	OK	An empty response	None
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

Markets

Get market bbo

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/bbo/{market}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/bbo/{market}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/bbo/{market} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/bbo/{market}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /bbo/{market}

Get the best bid/ask for the given market

Parameters

Name	In	Type	Required	Description
market	path	string	true	Market symbol - ex: BTC-USD-PERP

Example responses

200 Response

{
  "ask": "30130.15",
  "ask_size": "0.05",
  "bid": "30112.22",
  "bid_size": "0.04",
  "last_updated_at": 1681493939981,
  "market": "BTC-USD-PERP",
  "seq_no": 20784
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.BBOResp
400	Bad Request	Bad Request	responses.ApiError

Funding data history

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/funding/data', params={
  'market': 'BTC-USD-PERP'
}, headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/funding/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/funding/data?market=BTC-USD-PERP \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/funding/data?market=BTC-USD-PERP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /funding/data

List historical funding data by market

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	Returns the ‘next’ paginated page.
end_at	query	integer	false	End Time (unix time millisecond)
market	query	string	true	Market for which funding payments are queried
page_size	query	integer	false	Limit the number of responses in the page
start_at	query	integer	false	Start Time (unix time millisecond)

Example responses

200 Response

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "created_at": 0,
      "funding_index": "string",
      "funding_premium": "string",
      "funding_rate": "string",
      "market": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.FundingDataResp
400	Bad Request	Bad Request	responses.ApiError

List available markets

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/markets', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/markets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/markets \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/markets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /markets

Get markets static data component

Parameters

Name	In	Type	Required	Description
market	query	string	false	Market Name - example: BTC-USD-PERP

Example responses

200 Response

{
  "results": [
    {
      "asset_kind": "PERP",
      "base_currency": "ETH",
      "chain_details": {
        "collateral_address": "0x1234567890",
        "contract_address": "0x1234567890",
        "fee_account_address": "0x1234567890",
        "fee_maker": "0.01",
        "fee_taker": "0.01",
        "insurance_fund_address": "0x1234567890",
        "liquidation_fee": "0.01",
        "oracle_address": "0x1234567890",
        "symbol": "ETH-USD-PERP"
      },
      "clamp_rate": "0.05",
      "delta1_cross_margin_params": {
        "imf_base": "0.11",
        "imf_factor": "8001",
        "imf_shift": "0.00021",
        "mmf_factor": "0.51"
      },
      "expiry_at": 0,
      "interest_rate": "0.01",
      "market_kind": "cross",
      "max_funding_rate": "0.05",
      "max_funding_rate_change": "0.0005",
      "max_open_orders": 100,
      "max_order_size": "100",
      "max_tob_spread": "0.2",
      "min_notional": "10",
      "open_at": 0,
      "oracle_ewma_factor": "0.2",
      "order_size_increment": "0.001",
      "position_limit": "500",
      "price_bands_width": "0.05",
      "price_feed_id": "GVXRSBjFk6e6J3NbVPXohDJetcTjaeeuykUpbQF8UoMU",
      "price_tick_size": "0.01",
      "quote_currency": "USD",
      "settlement_currency": "USDC",
      "symbol": "ETH-USD-PERP"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetMarkets
404	Not Found	Not Found	responses.ApiError

OHLCV for a symbol

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/markets/klines', params={
  'end_at': '0',  'resolution': 'string',  'start_at': '0',  'symbol': 'string'
}, headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/markets/klines", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/markets/klines?end_at=0&resolution=string&start_at=0&symbol=string \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/markets/klines?end_at=0&resolution=string&start_at=0&symbol=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /markets/klines

Klines for a symbol

Parameters

Name	In	Type	Required	Description
end_at	query	integer	true	end time for klines in milliseconds
resolution	query	string	true	resolution in minutes: 1, 3, 5, 15, 30, 60
start_at	query	integer	true	start time for klines in milliseconds
symbol	query	string	true	Symbol of the market pair

Example responses

400 Response

{
  "data": null,
  "error": "NOT_ONBOARDED",
  "message": "User has never called /onboarding endpoint"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	responses.ApiError

List available markets summary

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/markets/summary', params={
  'market': 'BTC-USD-PERP'
}, headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/markets/summary", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/markets/summary?market=BTC-USD-PERP \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/markets/summary?market=BTC-USD-PERP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /markets/summary

Get markets dynamic data component

Parameters

Name	In	Type	Required	Description
end	query	integer	false	End Time (unix time millisecond)
market	query	string	true	Name of the market for which summary is requested (for all available markets use ALL)
start	query	integer	false	Start Time (unix time millisecond)

Example responses

200 Response

{
  "results": [
    {
      "ask": "30130.15",
      "bid": "30112.22",
      "created_at": 0,
      "funding_rate": "0.3",
      "last_traded_price": "30109.53",
      "mark_price": "29799.70877478",
      "open_interest": "6100048.3",
      "price_change_rate_24h": "0.05",
      "symbol": "BTC-USD-PERP",
      "total_volume": "141341.0424",
      "underlying_price": "29876.3",
      "volume_24h": "47041.0424"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetMarketSummary
400	Bad Request	Bad Request	responses.ApiError

Get market orderbook

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/orderbook/{market}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/orderbook/{market}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/orderbook/{market} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/orderbook/{market}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /orderbook/{market}

Get snapshot of the orderbook for the given market

Parameters

Name	In	Type	Required	Description
market	path	string	true	Market symbol - ex: BTC-USD-PERP
depth	query	integer	false	Depth

Example responses

200 Response

{
  "asks": [
    [
      "string"
    ]
  ],
  "bids": [
    [
      "string"
    ]
  ],
  "last_updated_at": 1681462770114,
  "market": "ETH-USD-PERP",
  "seq_no": 20784
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.AskBidArray
400	Bad Request	Bad Request	responses.ApiError

Insurance

Get insurance fund account information

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/insurance', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/insurance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/insurance \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/insurance',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /insurance

Get insurance fund account's information

Example responses

200 Response

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "account_value": "136285.069",
  "settlement_asset": "USDC",
  "updated_at": 1681471234972
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.InsuranceAccountResp

Liquidations

List liquidations

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/liquidations', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/liquidations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/liquidations \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/liquidations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /liquidations

Retrieves a list of liquidations associated to the requester's account

Parameters

Name	In	Type	Required	Description
from	query	integer	false	Start Time (unix time millisecond)
to	query	integer	false	End Time (unix time millisecond)

Example responses

200 Response

{
  "results": [
    {
      "created_at": 1697213130097,
      "id": "0x123456789"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetLiquidations
400	Bad Request	Bad Request	responses.ApiError

Orders

Get open orders

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/orders', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /orders

Get current user all open orders

Parameters

Name	In	Type	Required	Description
market	query	string	false	Market symbol, ex: BTC-USD-PERP

Example responses

200 Response

{
  "results": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "client_id": "x1234",
      "created_at": 1681493746016,
      "flags": [
        "REDUCE_ONLY"
      ],
      "id": "123456",
      "instruction": "GTC",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "price": "26000",
      "published_at": 1681493746016,
      "received_at": 1681493746016,
      "remaining_size": "0",
      "seq_no": 1681471234972000000,
      "side": "BUY",
      "size": "0.05",
      "status": "NEW",
      "stp": "EXPIRE_MAKER",
      "timestamp": 1681493746016,
      "trigger_price": "26000",
      "type": "MARKET"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetOpenOrders
400	Bad Request	Bad Request	responses.ApiError

Create order

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.post('https://api.testnet.paradex.trade/v1/orders', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.testnet.paradex.trade/v1/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X POST https://api.testnet.paradex.trade/v1/orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'

const inputBody = '{
  "client_id": "123454321",
  "flags": [
    "REDUCE_ONLY"
  ],
  "instruction": "string",
  "market": "BTC-USD-PERP",
  "price": "29500.12",
  "recv_window": 0,
  "side": "BUY",
  "signature": "string",
  "signature_timestamp": 0,
  "size": "1.213",
  "stp": "string",
  "trigger_price": "string",
  "type": "MARKET"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /orders

Open a new order

Body parameter

{
  "client_id": "123454321",
  "flags": [
    "REDUCE_ONLY"
  ],
  "instruction": "string",
  "market": "BTC-USD-PERP",
  "price": "29500.12",
  "recv_window": 0,
  "side": "BUY",
  "signature": "string",
  "signature_timestamp": 0,
  "size": "1.213",
  "stp": "string",
  "trigger_price": "string",
  "type": "MARKET"
}

Parameters

Name	In	Type	Required	Description
body	body	requests.OrderRequest	true	Order content

Example responses

201 Response

{
  "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
  "avg_fill_price": "26000",
  "cancel_reason": "NOT_ENOUGH_MARGIN",
  "client_id": "x1234",
  "created_at": 1681493746016,
  "flags": [
    "REDUCE_ONLY"
  ],
  "id": "123456",
  "instruction": "GTC",
  "last_updated_at": 1681493746016,
  "market": "BTC-USD-PERP",
  "price": "26000",
  "published_at": 1681493746016,
  "received_at": 1681493746016,
  "remaining_size": "0",
  "seq_no": 1681471234972000000,
  "side": "BUY",
  "size": "0.05",
  "status": "NEW",
  "stp": "EXPIRE_MAKER",
  "timestamp": 1681493746016,
  "trigger_price": "26000",
  "type": "MARKET"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	responses.OrderResp
400	Bad Request	Bad Request	responses.ApiError

Cancel all open orders

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.delete('https://api.testnet.paradex.trade/v1/orders', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.testnet.paradex.trade/v1/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X DELETE https://api.testnet.paradex.trade/v1/orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/orders',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /orders

Parameters

Name	In	Type	Required	Description
market	query	string	false	Market to cancel orders for

Example responses

400 Response

{
  "data": null,
  "error": "NOT_ONBOARDED",
  "message": "User has never called /onboarding endpoint"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	responses.ApiError

Get orders

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/orders-history', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/orders-history", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/orders-history \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/orders-history',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /orders-history

Get current user orders filtered on attributes

Parameters

Name	In	Type	Required	Description
client_id	query	string	false	Unique ID of client generating the order
cursor	query	string	false	Returns the ‘next’ paginated page.
end_at	query	integer	false	End Time (unix time millisecond)
market	query	string	false	Market for the order
page_size	query	integer	false	Limit the number of responses in the page
side	query	string	false	Order side
start_at	query	integer	false	Start Time (unix time millisecond)
status	query	string	false	Order status
type	query	string	false	Order type

Enumerated Values

Parameter	Value
side	BUY
side	SELL
status	OPEN
status	CLOSED
status	NEW
type	LIMIT
type	MARKET
type	STOP_LIMIT
type	STOP_MARKET

Example responses

200 Response

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "client_id": "x1234",
      "created_at": 1681493746016,
      "flags": [
        "REDUCE_ONLY"
      ],
      "id": "123456",
      "instruction": "GTC",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "price": "26000",
      "published_at": 1681493746016,
      "received_at": 1681493746016,
      "remaining_size": "0",
      "seq_no": 1681471234972000000,
      "side": "BUY",
      "size": "0.05",
      "status": "NEW",
      "stp": "EXPIRE_MAKER",
      "timestamp": 1681493746016,
      "trigger_price": "26000",
      "type": "MARKET"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetOrders
400	Bad Request	Bad Request	responses.ApiError

Create batch of orders

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.post('https://api.testnet.paradex.trade/v1/orders/batch', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.testnet.paradex.trade/v1/orders/batch", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X POST https://api.testnet.paradex.trade/v1/orders/batch \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'

const inputBody = '[
  {
    "client_id": "123454321",
    "flags": [
      "REDUCE_ONLY"
    ],
    "instruction": "string",
    "market": "BTC-USD-PERP",
    "price": "29500.12",
    "recv_window": 0,
    "side": "BUY",
    "signature": "string",
    "signature_timestamp": 0,
    "size": "1.213",
    "stp": "string",
    "trigger_price": "string",
    "type": "MARKET"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/orders/batch',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /orders/batch

[Experimental] Place a batch of orders
- Valid batch size is between 1-10 order(s)
- If basic validation(including signature) fails - all orders will be rejected.
- Orders are queued for risk checking independently and failure of one order doesn't affect processing of another order.

Body parameter

[
  {
    "client_id": "123454321",
    "flags": [
      "REDUCE_ONLY"
    ],
    "instruction": "string",
    "market": "BTC-USD-PERP",
    "price": "29500.12",
    "recv_window": 0,
    "side": "BUY",
    "signature": "string",
    "signature_timestamp": 0,
    "size": "1.213",
    "stp": "string",
    "trigger_price": "string",
    "type": "MARKET"
  }
]

Parameters

Name	In	Type	Required	Description
body	body	requests.OrderRequest	true	Order content

Example responses

201 Response

{
  "errors": [
    {
      "error": "VALIDATION_ERROR",
      "message": "string"
    }
  ],
  "orders": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "client_id": "x1234",
      "created_at": 1681493746016,
      "flags": [
        "REDUCE_ONLY"
      ],
      "id": "123456",
      "instruction": "GTC",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "price": "26000",
      "published_at": 1681493746016,
      "received_at": 1681493746016,
      "remaining_size": "0",
      "seq_no": 1681471234972000000,
      "side": "BUY",
      "size": "0.05",
      "status": "NEW",
      "stp": "EXPIRE_MAKER",
      "timestamp": 1681493746016,
      "trigger_price": "26000",
      "type": "MARKET"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	responses.BatchResponse
400	Bad Request	Bad Request	responses.ApiError

Get order by client id

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/orders/by_client_id/{client_id}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/orders/by_client_id/{client_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/orders/by_client_id/{client_id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/orders/by_client_id/{client_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /orders/by_client_id/{client_id}

Get an order by client id. Only returns orders in OPEN status.

Parameters

Name	In	Type	Required	Description
client_id	path	string	true	Client Order Id

Example responses

200 Response

{
  "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
  "avg_fill_price": "26000",
  "cancel_reason": "NOT_ENOUGH_MARGIN",
  "client_id": "x1234",
  "created_at": 1681493746016,
  "flags": [
    "REDUCE_ONLY"
  ],
  "id": "123456",
  "instruction": "GTC",
  "last_updated_at": 1681493746016,
  "market": "BTC-USD-PERP",
  "price": "26000",
  "published_at": 1681493746016,
  "received_at": 1681493746016,
  "remaining_size": "0",
  "seq_no": 1681471234972000000,
  "side": "BUY",
  "size": "0.05",
  "status": "NEW",
  "stp": "EXPIRE_MAKER",
  "timestamp": 1681493746016,
  "trigger_price": "26000",
  "type": "MARKET"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.OrderResp
400	Bad Request	Bad Request	responses.ApiError

Cancel open order by client order id

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.delete('https://api.testnet.paradex.trade/v1/orders/by_client_id/{client_id}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.testnet.paradex.trade/v1/orders/by_client_id/{client_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X DELETE https://api.testnet.paradex.trade/v1/orders/by_client_id/{client_id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/orders/by_client_id/{client_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /orders/by_client_id/{client_id}

Parameters

Name	In	Type	Required	Description
client_id	path	string	true	Client Order Id

Example responses

400 Response

{
  "data": null,
  "error": "NOT_ONBOARDED",
  "message": "User has never called /onboarding endpoint"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	responses.ApiError

Get order

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/orders/{order_id}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/orders/{order_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/orders/{order_id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/orders/{order_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /orders/{order_id}

Get an order by id. Only return orders in OPEN or NEW status.

Parameters

Name	In	Type	Required	Description
order_id	path	string	true	Order Id

Example responses

200 Response

{
  "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
  "avg_fill_price": "26000",
  "cancel_reason": "NOT_ENOUGH_MARGIN",
  "client_id": "x1234",
  "created_at": 1681493746016,
  "flags": [
    "REDUCE_ONLY"
  ],
  "id": "123456",
  "instruction": "GTC",
  "last_updated_at": 1681493746016,
  "market": "BTC-USD-PERP",
  "price": "26000",
  "published_at": 1681493746016,
  "received_at": 1681493746016,
  "remaining_size": "0",
  "seq_no": 1681471234972000000,
  "side": "BUY",
  "size": "0.05",
  "status": "NEW",
  "stp": "EXPIRE_MAKER",
  "timestamp": 1681493746016,
  "trigger_price": "26000",
  "type": "MARKET"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.OrderResp
400	Bad Request	Bad Request	responses.ApiError

Cancel order

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.delete('https://api.testnet.paradex.trade/v1/orders/{order_id}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.testnet.paradex.trade/v1/orders/{order_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X DELETE https://api.testnet.paradex.trade/v1/orders/{order_id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/orders/{order_id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /orders/{order_id}

Parameters

Name	In	Type	Required	Description
order_id	path	string	true	Order Id

Example responses

400 Response

{
  "data": null,
  "error": "NOT_ONBOARDED",
  "message": "User has never called /onboarding endpoint"
}

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	responses.ApiError

Points

List latest points data

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/points_data/{market}/{program}', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/points_data/{market}/{program}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/points_data/{market}/{program} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/points_data/{market}/{program}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /points_data/{market}/{program}

Get latest points data for requester's account

Parameters

Name	In	Type	Required	Description
market	path	string	true	Market Name - example: BTC-USD-PERP, ALL
program	path	string	true	Program Name - example: Maker, Fee

Example responses

200 Response

{
  "results": [
    {
      "maker_volume_score": "0",
      "market": "ETH-USD-PERP",
      "market_pool_share": "0.56",
      "pool": "Tier1",
      "previous_updated_at": 1696291100000,
      "program": "Maker",
      "quote_quality": "71.643",
      "sample_ask_quote_quality": "673.746",
      "sample_bid_quote_quality": "82.998",
      "sample_quote_quality": "260.222",
      "score_share": "0.0123",
      "total_accrued_points": "1.234",
      "total_distributed_points": "150.231",
      "total_market_score": "1003.65",
      "updated_at": 1696291200000,
      "wallet_score": "123.45"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetPoints
404	Not Found	Not Found	responses.ApiError

Referrals

Get referral config

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/referrals/config', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/referrals/config", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/referrals/config \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/referrals/config',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /referrals/config

Get referral program config data

Example responses

200 Response

{
  "results": [
    {
      "commission_rate": "0.1",
      "commission_volume_cap": "1000000000",
      "discount_rate": "0.1",
      "discount_volume_cap": "30000000",
      "minimum_volume": "0.123",
      "points_bonus_rate": "0.1",
      "points_bonus_volume_cap": "30000000",
      "referral_type": "Referral"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetReferralConfig
400	Bad Request	Bad Request	responses.ApiError

Get account referral details

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/referrals/summary', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/referrals/summary", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/referrals/summary \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/referrals/summary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /referrals/summary

Get latest referree data for requester's account

Example responses

200 Response

{
  "results": [
    {
      "address": "string",
      "created_at": 1715592690488,
      "referral_code": "maxdegen01",
      "referral_rewards": "0.123",
      "volume_traded": "0.123"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetReferrals
400	Bad Request	Bad Request	responses.ApiError
401	Unauthorized	Unauthorized	responses.ApiError

System

Get system config

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/system/config', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/system/config", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/system/config \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/system/config',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /system/config

Get clearing and settlement layer config for Paradex

Example responses

200 Response

{
  "block_explorer_url": "https://voyager.testnet.paradex.trade/",
  "bridged_tokens": [
    {
      "decimals": 0,
      "l1_bridge_address": "string",
      "l1_token_address": "string",
      "l2_bridge_address": "string",
      "l2_token_address": "string",
      "name": "string",
      "symbol": "string"
    }
  ],
  "environment": "local",
  "l1_chain_id": "5",
  "l1_core_contract_address": "0x182FE62c57461d4c5Ab1aE6F04f1D51aA1607daf",
  "l1_operator_address": "0x63e762538C70442758Fd622116d817761c94FD6A",
  "liquidation_fee": "0.20",
  "oracle_address": "0x47c622ce5f7ff7fa17725df596f4f506364e49be0621eb142a75b44ee3689c6",
  "paraclear_account_hash": "0x033434ad846cdd5f23eb73ff09fe6fddd568284a0fb7d1be20ee482f044dabe2",
  "paraclear_account_proxy_hash": "0x3530cc4759d78042f1b543bf797f5f3d647cde0388c33734cf91b7f7b9314a9",
  "paraclear_address": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7554d",
  "paraclear_decimals": 0,
  "partial_liquidation_buffer": "0.2",
  "partial_liquidation_share_increment": "0.05",
  "starknet_chain_id": "SN_CHAIN_ID",
  "starknet_fullnode_rpc_url": "https://pathfinder.api.testnet.paradex.trade/rpc/v0_7",
  "starknet_gateway_url": "https://potc-testnet-02.starknet.io",
  "universal_deployer_address": "0x1f3f9d3f1f0b7f3f9f3f9f3f9f3f9f3f9f3f9f3f"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.SystemConfigResponse

Get system state

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/system/state', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/system/state", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/system/state \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/system/state',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /system/state

Get the current state of the Paradex system

Example responses

200 Response

{
  "status": "ok"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.SystemStateResponse

Get system time (unix milliseconds)

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/system/time', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/system/time", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/system/time \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/system/time',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /system/time

Get the current time in the Paradex

Example responses

200 Response

{
  "server_time": "1681493415023"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.SystemTimeResponse

Trades

Trade tape

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.testnet.paradex.trade/v1/trades', params={
  'market': 'BTC-USD-PERP'
}, headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/trades", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/trades?market=BTC-USD-PERP \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('https://api.testnet.paradex.trade/v1/trades?market=BTC-USD-PERP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /trades

List trades that happened on a given market (trade tape).

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	Returns the ‘next’ paginated page.
end_at	query	integer	false	End Time (unix time millisecond)
market	query	string	true	Market name
page_size	query	integer	false	Limit the number of responses in the page
start_at	query	integer	false	Start Time (unix time millisecond)

Example responses

200 Response

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "created_at": 1681497002041,
      "id": "12345643",
      "market": "BTC-USD-PERP",
      "price": "30001.2",
      "side": "BUY",
      "size": "0.01",
      "trade_type": "FILL"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetTradesResp
400	Bad Request	Bad Request	responses.ApiError

Transfers

List account's transfers, i.e. deposits and withdrawals

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {JWT}'
}

r = requests.get('https://api.testnet.paradex.trade/v1/transfers', headers = headers)

print(r.json())

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {JWT}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.testnet.paradex.trade/v1/transfers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

# You can also use wget
curl -X GET https://api.testnet.paradex.trade/v1/transfers \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {JWT}'


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {JWT}'
};

fetch('https://api.testnet.paradex.trade/v1/transfers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /transfers

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	Returns the ‘next’ paginated page.
end_at	query	integer	false	End Time (unix time millisecond)
page_size	query	integer	false	Limit the number of responses in the page
start_at	query	integer	false	Start Time (unix time millisecond)
status	query	string	false	none

Enumerated Values

Parameter	Value
status	PENDING
status	AVAILABLE
status	COMPLETED
status	FAILED

Example responses

200 Response

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "amount": "100",
      "bridge": "STARKGATE",
      "created_at": 1681497002041,
      "external_account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "external_chain": "ETHEREUM",
      "external_txn_hash": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "failure_reason": "Gas fee too low",
      "id": "123456789",
      "kind": "DEPOSIT",
      "last_updated_at": 1681497002041,
      "socialized_loss_factor": "0",
      "status": "PENDING",
      "token": "USDC",
      "txn_hash": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	responses.GetTransfersResponse
400	Bad Request	Bad Request	responses.ApiError

Schemas

message.TwitterProfile

{
  "id": "string",
  "image_url": "string",
  "username": "string"
}

Properties

Name	Type	Required	Description
id	string	false	none
image_url	string	false	none
username	string	false	none

requests.AlgoOrderRequest

{
  "algo_type": "TWAP",
  "duration_seconds": 3600,
  "market": "BTC-USD-PERP",
  "side": "MARKET",
  "signature": "string",
  "signature_timestamp": 0,
  "size": "1.213",
  "type": "MARKET"
}

Properties

Name	Type	Required	Description
algo_type	string	true	Algo type, required for algo orders creation
duration_seconds	integer	true	Duration in seconds for which the algo order will be running, required for algo orders creation
market	string	true	Market for which order is created
side	responses.OrderSide	true	Algo order side
signature	string	true	Order Payload signed with STARK Private Key
signature_timestamp	integer	true	Timestamp of order creation, used for signature verification
size	string	true	Size of the algo order
type	responses.OrderType	true	Algo order type, only MARKET is supported

requests.Onboarding

{
  "public_key": "0x3d9f2b2e5f50c1aade60ca540368cd7490160f41270c192c05729fe35b656a9",
  "referral_code": "cryptofox8"
}

Properties

Name	Type	Required	Description
public_key	string	false	Public key of the user being onboarded.
referral_code	string	false	Referral code of the user who referred the user being onboarded.

requests.OrderRequest

{
  "client_id": "123454321",
  "flags": [
    "REDUCE_ONLY"
  ],
  "instruction": "string",
  "market": "BTC-USD-PERP",
  "price": "29500.12",
  "recv_window": 0,
  "side": "BUY",
  "signature": "string",
  "signature_timestamp": 0,
  "size": "1.213",
  "stp": "string",
  "trigger_price": "string",
  "type": "MARKET"
}

Properties

Name	Type	Required	Description
client_id	string	false	Unique client assigned ID for the order
flags	[responses.OrderFlag]	false	Order flags, allow flag: REDUCE_ONLY
instruction	string	true	Order Instruction, GTC, IOC or POST_ONLY if empty GTC
market	string	true	Market for which order is created
price	string	true	Order price
recv_window	integer	false	Order will be created if it is received by API within RecvWindow milliseconds from signature timestamp, minimum is 10 milliseconds
side	responses.OrderSide	true	Order side
signature	string	true	Order Payload signed with STARK Private Key
signature_timestamp	integer	true	Timestamp of order creation, used for signature verification
size	string	true	Size of the order
stp	string	false	Self Trade Prevention, EXPIRE_MAKER, EXPIRE_TAKER or EXPIRE_BOTH, if empty EXPIRE_TAKER
trigger_price	string	false	Trigger price for stop order
type	responses.OrderType	true	Order type

responses.AccountInfoResponse

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "created_at": 1681471234972,
  "derivation_path": "m/44'/9004'/0'/0/1",
  "isolated_market": "ETHUSD-PERP",
  "kind": "main",
  "parent_account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d",
  "public_key": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d"
}

Properties

Name	Type	Required	Description
account	string	false	Starknet address of the account
created_at	integer	false	Account creation time
derivation_path	string	false	Account derivation path used to derive the account, if a sub-account
isolated_market	string	false	Isolated market for the account
kind	responses.AccountKind	false	Account kind
parent_account	string	false	Starknet address of the parent account
public_key	string	false	Starknet public key

responses.AccountKind

""

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous
anonymous	main
anonymous	subaccount
anonymous	vault_operator

responses.AccountProfileResp

{
  "is_username_private": true,
  "programs_eligibility": {
    "affiliate": "Pending",
    "fee": "True",
    "maker": "True",
    "referral": "False"
  },
  "referral_code": "cryptofox8",
  "referred_by": "maxDegen",
  "twitter": {
    "id": "string",
    "image_url": "string",
    "username": "string"
  },
  "username": "username"
}

Properties

Name	Type	Required	Description
is_username_private	boolean	false	none
programs_eligibility	responses.ProgramsEligibility	false	none
referral_code	string	false	none
referred_by	string	false	none
twitter	message.TwitterProfile	false	none
username	string	false	none

responses.AccountSummaryResponse

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "account_value": "136285.06918911",
  "free_collateral": "73276.47229774",
  "initial_margin_requirement": "63008.59689218",
  "maintenance_margin_requirement": "31597.25239676",
  "margin_cushion": "104687.8167956",
  "seq_no": 1681471234972000000,
  "settlement_asset": "USDC",
  "status": "ACTIVE",
  "total_collateral": "123003.62047353",
  "updated_at": 1681471234972
}

Properties

Name	Type	Required	Description
account	string	false	User's starknet account
account_value	string	false	Current account value [with unrealized P&Ls]
free_collateral	string	false	Free collateral available (Account value in excess of Initial Margin required)
initial_margin_requirement	string	false	Amount required to open trade for the existing positions
maintenance_margin_requirement	string	false	Amount required to maintain exisiting positions
margin_cushion	string	false	Acc value in excess of maintenance margin required
seq_no	integer	false	Unique increasing number (non-sequential) that is assigned to this account update. Can be used to deduplicate multiple feeds
settlement_asset	string	false	Settlement asset for the account
status	string	false	Status of the acc - like ACTIVE, LIQUIDATION
total_collateral	string	false	User's total collateral
updated_at	integer	false	Account last updated time

responses.AlgoOrderResp

{
  "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512",
  "algo_type": "TWAP",
  "avg_fill_price": "26000",
  "cancel_reason": "NOT_ENOUGH_MARGIN",
  "created_at": 1681493746016,
  "end_at": 1681493746016,
  "id": "123456",
  "last_updated_at": 1681493746016,
  "market": "BTC-USD-PERP",
  "remaining_size": "0",
  "side": "BUY",
  "size": "0.05",
  "status": "NEW"
}

Properties

Name	Type	Required	Description
account	string	false	Account identifier (user's account address)
algo_type	responses.AlgoType	false	Algo type
avg_fill_price	string	false	Average fill price of the order
cancel_reason	string	false	Reason for algo cancellation if it was closed by cancel
created_at	integer	false	Algo creation time
end_at	integer	false	Algo end time
id	string	false	Unique algo identifier
last_updated_at	integer	false	Algo last update time. No changes once status=CLOSED
market	string	false	Market to which algo belongs
remaining_size	string	false	Remaining size of the algo
side	responses.OrderSide	false	Algo side
size	string	false	Algo size
status	responses.OrderStatus	false	Algo status

responses.AlgoType

""

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous
anonymous	TWAP

responses.ApiError

{
  "data": null,
  "error": "NOT_ONBOARDED",
  "message": "User has never called /onboarding endpoint"
}

Properties

Name	Type	Required	Description
data	any	false	any additional data related to the error
error	responses.ErrorCode	false	unique immutable string identifier for specific error
message	string	false	detailed description of error and how to address it

responses.AskBidArray

{
  "asks": [
    [
      "string"
    ]
  ],
  "bids": [
    [
      "string"
    ]
  ],
  "last_updated_at": 1681462770114,
  "market": "ETH-USD-PERP",
  "seq_no": 20784
}

Properties

Name	Type	Required	Description
asks	[array]	false	List of Ask sizes and prices
bids	[array]	false	List of Bid sizes and prices
last_updated_at	integer	false	Last update to the orderbook in milliseconds
market	string	false	Market name
seq_no	integer	false	Sequence number of the orderbook

responses.AuthResp

{
  "jwt_token": "eyJhbGciOiJFUzM4NCIsInR5cCI6IkpXVCJ9.eyJ0eXAiOiJhdCtKV1QiLCJleHAiOjE2ODE0NTI5MDcsImlhdCI6MTY4MTQ1MjYwNywiaXNzIjoiUGFyYWRleCBzdGFnaW5nIiwic3ViIjoiMHg0OTVkMmViNTIzNmExMmI4YjRhZDdkMzg0OWNlNmEyMDNjZTIxYzQzZjQ3M2MyNDhkZmQ1Y2U3MGQ5NDU0ZmEifQ.BPihIbGhnnsuPlReqC9x12JFXldpswg5EdA6tTiDQm-_UHaRz_8RfVBqWc2fPN6CzFsXTq7GowZu-2qMxPvZK_fGcxEhTp2k1r8MUxowlUIT4vPu2scCwrsyIujlCAwS"
}

Properties

Name	Type	Required	Description
jwt_token	string	false	Authentication token

responses.BBOResp

{
  "ask": "30130.15",
  "ask_size": "0.05",
  "bid": "30112.22",
  "bid_size": "0.04",
  "last_updated_at": 1681493939981,
  "market": "BTC-USD-PERP",
  "seq_no": 20784
}

Properties

Name	Type	Required	Description
ask	string	false	Best ask price
ask_size	string	false	Best ask size
bid	string	false	Best bid price
bid_size	string	false	Best bid size
last_updated_at	integer	false	Last update to the orderbook in milliseconds
market	string	false	Symbol of the market
seq_no	integer	false	Sequence number of the orderbook

responses.BalanceResp

{
  "last_updated_at": 1681462770114,
  "size": "123003.620",
  "token": "USDC"
}

Properties

Name	Type	Required	Description
last_updated_at	integer	false	Balance last updated time
size	string	false	Balance amount of settlement token (includes deposits, withdrawals, realized PnL, realized funding, and fees)
token	string	false	Name of the token

responses.BatchResponse

{
  "errors": [
    {
      "error": "VALIDATION_ERROR",
      "message": "string"
    }
  ],
  "orders": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "client_id": "x1234",
      "created_at": 1681493746016,
      "flags": [
        "REDUCE_ONLY"
      ],
      "id": "123456",
      "instruction": "GTC",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "price": "26000",
      "published_at": 1681493746016,
      "received_at": 1681493746016,
      "remaining_size": "0",
      "seq_no": 1681471234972000000,
      "side": "BUY",
      "size": "0.05",
      "status": "NEW",
      "stp": "EXPIRE_MAKER",
      "timestamp": 1681493746016,
      "trigger_price": "26000",
      "type": "MARKET"
    }
  ]
}

Properties

Name	Type	Required	Description
errors	[responses.ErrorResponse]	false	none
orders	[responses.OrderResp]	false	none

responses.BridgedToken

{
  "decimals": 0,
  "l1_bridge_address": "string",
  "l1_token_address": "string",
  "l2_bridge_address": "string",
  "l2_token_address": "string",
  "name": "string",
  "symbol": "string"
}

Properties

Name	Type	Required	Description
decimals	integer	false	none
l1_bridge_address	string	false	none
l1_token_address	string	false	none
l2_bridge_address	string	false	none
l2_token_address	string	false	none
name	string	false	none
symbol	string	false	none

responses.Delta1CrossMarginParams

{
  "imf_base": "0.11",
  "imf_factor": "8001",
  "imf_shift": "0.00021",
  "mmf_factor": "0.51"
}

Properties

Name	Type	Required	Description
imf_base	string	false	Initial Margin Base
imf_factor	string	false	Initial Margin Factor
imf_shift	string	false	Initial Margin Shift
mmf_factor	string	false	Maintenance Margin Factor

responses.ErrorCode

"VALIDATION_ERROR"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	VALIDATION_ERROR
anonymous	BINDING_ERROR
anonymous	INTERNAL_ERROR
anonymous	NOT_FOUND
anonymous	SERVICE_UNAVAILABLE
anonymous	INVALID_REQUEST_PARAMETER
anonymous	ORDER_ID_NOT_FOUND
anonymous	ORDER_IS_CLOSED
anonymous	ORDER_IS_NOT_OPEN_YET
anonymous	CLIENT_ORDER_ID_NOT_FOUND
anonymous	DUPLICATED_CLIENT_ID
anonymous	INVALID_PRICE_PRECISION
anonymous	INVALID_SYMBOL
anonymous	INVALID_TOKEN
anonymous	INVALID_ETHEREUM_ADDRESS
anonymous	INVALID_ETHEREUM_SIGNATURE
anonymous	INVALID_STARKNET_ADDRESS
anonymous	INVALID_STARKNET_SIGNATURE
anonymous	STARKNET_SIGNATURE_VERIFICATION_FAILED
anonymous	BAD_STARKNET_REQUEST
anonymous	ETHEREUM_SIGNER_MISMATCH
anonymous	ETHEREUM_HASH_MISMATCH
anonymous	NOT_ONBOARDED
anonymous	INVALID_TIMESTAMP
anonymous	INVALID_SIGNATURE_EXPIRATION
anonymous	ACCOUNT_NOT_FOUND
anonymous	INVALID_ORDER_SIGNATURE
anonymous	PUBLIC_KEY_INVALID
anonymous	UNAUTHORIZED_ETHEREUM_ADDRESS
anonymous	ETHEREUM_ADDRESS_ALREADY_ONBOARDED
anonymous	MARKET_NOT_FOUND
anonymous	ALLOWLIST_ENTRY_NOT_FOUND
anonymous	USERNAME_IN_USE
anonymous	GEO_IP_BLOCK
anonymous	ETHEREUM_ADDRESS_BLOCKED
anonymous	PROGRAM_NOT_FOUND
anonymous	INVALID_DASHBOARD
anonymous	MARKET_NOT_OPEN
anonymous	INVALID_REFERRAL_CODE
anonymous	REQUEST_NOT_ALLOWED
anonymous	PARENT_ADDRESS_ALREADY_ONBOARDED
anonymous	INVALID_PARENT_ACCOUNT
anonymous	INVALID_VAULT_OPERATOR_CHAIN
anonymous	VAULT_OPERATOR_ALREADY_ONBOARDED
anonymous	VAULT_NAME_IN_USE
anonymous	VAULT_NOT_FOUND
anonymous	VAULT_LIMIT_REACHED
anonymous	BATCH_SIZE_OUT_OF_RANGE
anonymous	ISOLATED_MARKET_ACCOUNT_MISMATCH
anonymous	POINTS_SUMMARY_NOT_FOUND
anonymous	ALGO_ID_NOT_FOUND
anonymous	INVALID_DERIVATION_PATH

responses.ErrorResponse

{
  "error": "VALIDATION_ERROR",
  "message": "string"
}

Properties

Name	Type	Required	Description
error	responses.ErrorCode	false	none
message	string	false	none

responses.FillResult

{
  "client_id": "x1234",
  "created_at": 1681375176910,
  "fee": "7.56",
  "fee_currency": "USDC",
  "fill_type": "FILL",
  "id": "8615262148007718462",
  "liquidity": "TAKER",
  "market": "BTC-USD-PERP",
  "order_id": "1681462103821101699438490000",
  "price": "30000.12",
  "remaining_size": "0.5",
  "side": "BUY",
  "size": "0.5"
}

Properties

Name	Type	Required	Description
client_id	string	false	Unique client assigned ID for the order
created_at	integer	false	Fill time
fee	string	false	Fee paid by the user
fee_currency	string	false	Asset that fee is charged in
fill_type	string	false	Fill type, can be FILL or LIQUIDATION
id	string	false	Unique string ID of fill per FillType
liquidity	responses.TraderRole	false	Maker or Taker
market	string	false	Market name
order_id	string	false	Order ID
price	string	false	Price at which order was filled
remaining_size	string	false	Remaining size of the order
side	responses.OrderSide	false	Taker side
size	string	false	Size of the fill

responses.FundingDataResp

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "created_at": 0,
      "funding_index": "string",
      "funding_premium": "string",
      "funding_rate": "string",
      "market": "string"
    }
  ]
}

Properties

Name	Type	Required	Description
next	string	false	The pointer to fetch next set of records (null if there are no records left)
prev	string	false	The pointer to fetch previous set of records (null if there are no records left)
results	[responses.FundingDataResult]	false	Funding Data Response data list

responses.FundingDataResult

{
  "created_at": 0,
  "funding_index": "string",
  "funding_premium": "string",
  "funding_rate": "string",
  "market": "string"
}

Properties

Name	Type	Required	Description
created_at	integer	false	none
funding_index	string	false	none
funding_premium	string	false	none
funding_rate	string	false	none
market	string	false	none

responses.FundingHistoryResp

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "created_at": 1681375481000,
      "fill_id": "8615262148007718462",
      "id": "1681375578221101699352320000",
      "index": "-2819.53434361",
      "market": "BTC-USD-PERP",
      "payment": "34.4490622"
    }
  ]
}

Properties

Name	Type	Required	Description
next	string	false	The pointer to fetch next set of records (null if there are no records left)
prev	string	false	The pointer to fetch previous set of records (null if there are no records left)
results	[responses.FundingResp]	false	Funding Response data list

responses.FundingResp

{
  "created_at": 1681375481000,
  "fill_id": "8615262148007718462",
  "id": "1681375578221101699352320000",
  "index": "-2819.53434361",
  "market": "BTC-USD-PERP",
  "payment": "34.4490622"
}

Properties

Name	Type	Required	Description
created_at	integer	false	Funding payments time
fill_id	string	false	Unique string ID for the fill that triggered the payment (if any)
id	string	false	Unique string ID to identify the payment
index	string	false	Value of the funding index at the time of payment
market	string	false	Perpetual market against which payment is made
payment	string	false	Payment amount in settlement asset

responses.GetAccountsInfoResponse

{
  "results": [
    {
      "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "created_at": 1681471234972,
      "derivation_path": "m/44'/9004'/0'/0/1",
      "isolated_market": "ETHUSD-PERP",
      "kind": "main",
      "parent_account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d",
      "public_key": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.AccountInfoResponse]	false	none

responses.GetAlgoOrders

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512",
      "algo_type": "TWAP",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "created_at": 1681493746016,
      "end_at": 1681493746016,
      "id": "123456",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "remaining_size": "0",
      "side": "BUY",
      "size": "0.05",
      "status": "NEW"
    }
  ]
}

Properties

Name	Type	Required	Description
next	string	false	The pointer to fetch next set of records (null if there are no records left)
prev	string	false	The pointer to fetch previous set of records (null if there are no records left)
results	[responses.AlgoOrderResp]	false	List of Algo orders responses

responses.GetBalancesResp

{
  "results": [
    {
      "last_updated_at": 1681462770114,
      "size": "123003.620",
      "token": "USDC"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.BalanceResp]	false	Array of token balances held

responses.GetFillsResp

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "client_id": "x1234",
      "created_at": 1681375176910,
      "fee": "7.56",
      "fee_currency": "USDC",
      "fill_type": "FILL",
      "id": "8615262148007718462",
      "liquidity": "TAKER",
      "market": "BTC-USD-PERP",
      "order_id": "1681462103821101699438490000",
      "price": "30000.12",
      "remaining_size": "0.5",
      "side": "BUY",
      "size": "0.5"
    }
  ]
}

Properties

Name	Type	Required	Description
next	string	false	The pointer to fetch next set of records (null if there are no records left)
prev	string	false	The pointer to fetch previous set of records (null if there are no records left)
results	[responses.FillResult]	false	Fill Results List

responses.GetLiquidations

{
  "results": [
    {
      "created_at": 1697213130097,
      "id": "0x123456789"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.LiquidationResp]	false	List of liquidations

responses.GetMarketSummary

{
  "results": [
    {
      "ask": "30130.15",
      "bid": "30112.22",
      "created_at": 0,
      "funding_rate": "0.3",
      "last_traded_price": "30109.53",
      "mark_price": "29799.70877478",
      "open_interest": "6100048.3",
      "price_change_rate_24h": "0.05",
      "symbol": "BTC-USD-PERP",
      "total_volume": "141341.0424",
      "underlying_price": "29876.3",
      "volume_24h": "47041.0424"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.MarketSummaryResp]	false	List of market summaries

responses.GetMarkets

{
  "results": [
    {
      "asset_kind": "PERP",
      "base_currency": "ETH",
      "chain_details": {
        "collateral_address": "0x1234567890",
        "contract_address": "0x1234567890",
        "fee_account_address": "0x1234567890",
        "fee_maker": "0.01",
        "fee_taker": "0.01",
        "insurance_fund_address": "0x1234567890",
        "liquidation_fee": "0.01",
        "oracle_address": "0x1234567890",
        "symbol": "ETH-USD-PERP"
      },
      "clamp_rate": "0.05",
      "delta1_cross_margin_params": {
        "imf_base": "0.11",
        "imf_factor": "8001",
        "imf_shift": "0.00021",
        "mmf_factor": "0.51"
      },
      "expiry_at": 0,
      "interest_rate": "0.01",
      "market_kind": "cross",
      "max_funding_rate": "0.05",
      "max_funding_rate_change": "0.0005",
      "max_open_orders": 100,
      "max_order_size": "100",
      "max_tob_spread": "0.2",
      "min_notional": "10",
      "open_at": 0,
      "oracle_ewma_factor": "0.2",
      "order_size_increment": "0.001",
      "position_limit": "500",
      "price_bands_width": "0.05",
      "price_feed_id": "GVXRSBjFk6e6J3NbVPXohDJetcTjaeeuykUpbQF8UoMU",
      "price_tick_size": "0.01",
      "quote_currency": "USD",
      "settlement_currency": "USDC",
      "symbol": "ETH-USD-PERP"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.MarketResp]	false	List of available active markets

responses.GetOpenAlgoOrders

{
  "results": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512",
      "algo_type": "TWAP",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "created_at": 1681493746016,
      "end_at": 1681493746016,
      "id": "123456",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "remaining_size": "0",
      "side": "BUY",
      "size": "0.05",
      "status": "NEW"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.AlgoOrderResp]	false	List of Algo orders responses

responses.GetOpenOrders

{
  "results": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "client_id": "x1234",
      "created_at": 1681493746016,
      "flags": [
        "REDUCE_ONLY"
      ],
      "id": "123456",
      "instruction": "GTC",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "price": "26000",
      "published_at": 1681493746016,
      "received_at": 1681493746016,
      "remaining_size": "0",
      "seq_no": 1681471234972000000,
      "side": "BUY",
      "size": "0.05",
      "status": "NEW",
      "stp": "EXPIRE_MAKER",
      "timestamp": 1681493746016,
      "trigger_price": "26000",
      "type": "MARKET"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.OrderResp]	false	Orders list

responses.GetOrders

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
      "avg_fill_price": "26000",
      "cancel_reason": "NOT_ENOUGH_MARGIN",
      "client_id": "x1234",
      "created_at": 1681493746016,
      "flags": [
        "REDUCE_ONLY"
      ],
      "id": "123456",
      "instruction": "GTC",
      "last_updated_at": 1681493746016,
      "market": "BTC-USD-PERP",
      "price": "26000",
      "published_at": 1681493746016,
      "received_at": 1681493746016,
      "remaining_size": "0",
      "seq_no": 1681471234972000000,
      "side": "BUY",
      "size": "0.05",
      "status": "NEW",
      "stp": "EXPIRE_MAKER",
      "timestamp": 1681493746016,
      "trigger_price": "26000",
      "type": "MARKET"
    }
  ]
}

Properties

Name	Type	Required	Description
next	string	false	The pointer to fetch next set of records (null if there are no records left)
prev	string	false	The pointer to fetch previous set of records (null if there are no records left)
results	[responses.OrderResp]	false	List of Orders

responses.GetPoints

{
  "results": [
    {
      "maker_volume_score": "0",
      "market": "ETH-USD-PERP",
      "market_pool_share": "0.56",
      "pool": "Tier1",
      "previous_updated_at": 1696291100000,
      "program": "Maker",
      "quote_quality": "71.643",
      "sample_ask_quote_quality": "673.746",
      "sample_bid_quote_quality": "82.998",
      "sample_quote_quality": "260.222",
      "score_share": "0.0123",
      "total_accrued_points": "1.234",
      "total_distributed_points": "150.231",
      "total_market_score": "1003.65",
      "updated_at": 1696291200000,
      "wallet_score": "123.45"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.PointsResp]	false	List of available active markets

responses.GetPositionsResp

{
  "results": [
    {
      "average_entry_price": "29001.34",
      "average_entry_price_usd": "29001.34",
      "cached_funding_index": "1234.3",
      "cost": "-10005.4623",
      "cost_usd": "-10005.4623",
      "id": "1234234",
      "last_fill_id": "1234234",
      "last_updated_at": 1681493939981,
      "leverage": "string",
      "liquidation_price": "string",
      "market": "BTC-USD-PERP",
      "seq_no": 1681471234972000000,
      "side": "SHORT",
      "size": "-0.345",
      "status": "OPEN",
      "unrealized_funding_pnl": "12.234",
      "unrealized_pnl": "-123.23"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.PositionResp]	false	none

responses.GetReferralConfig

{
  "results": [
    {
      "commission_rate": "0.1",
      "commission_volume_cap": "1000000000",
      "discount_rate": "0.1",
      "discount_volume_cap": "30000000",
      "minimum_volume": "0.123",
      "points_bonus_rate": "0.1",
      "points_bonus_volume_cap": "30000000",
      "referral_type": "Referral"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.ReferralConfigResp]	false	List of referral config

responses.GetReferrals

{
  "results": [
    {
      "address": "string",
      "created_at": 1715592690488,
      "referral_code": "maxdegen01",
      "referral_rewards": "0.123",
      "volume_traded": "0.123"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.ReferralsResp]	false	List of referral details

responses.GetSubAccountsResponse

{
  "results": [
    {
      "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "created_at": 1681471234972,
      "derivation_path": "m/44'/9004'/0'/0/1",
      "isolated_market": "ETHUSD-PERP",
      "kind": "main",
      "parent_account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d",
      "public_key": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d"
    }
  ]
}

Properties

Name	Type	Required	Description
results	[responses.AccountInfoResponse]	false	none

responses.GetTradebustsResp

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "busted_fill_id": "12342345",
      "created_at": 1681497002041
    }
  ]
}

Properties

Name	Type	Required	Description
next	string	false	The pointer to fetch next set of records (null if there are no records left)
prev	string	false	The pointer to fetch previous set of records (null if there are no records left)
results	[responses.TradebustResult]	false	List of tradebusts

responses.GetTradesResp

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "created_at": 1681497002041,
      "id": "12345643",
      "market": "BTC-USD-PERP",
      "price": "30001.2",
      "side": "BUY",
      "size": "0.01",
      "trade_type": "FILL"
    }
  ]
}

Properties

Name	Type	Required	Description
next	string	false	The pointer to fetch next set of records (null if there are no records left)
prev	string	false	The pointer to fetch previous set of records (null if there are no records left)
results	[responses.TradeResult]	false	List of trade details

responses.GetTransactionResponse

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "completed_at": 0,
      "created_at": 0,
      "hash": "0x445c05d6bfb899e39338440d199971c4d7f4cde7878ed3888df3f716efb8df2",
      "id": "12342423",
      "state": "ACCEPTED_ON_L1",
      "type": "TRANSACTION_FILL"
    }
  ]
}

Properties

Name	Type	Required	Description
next	string	false	The pointer to fetch next set of records (null if there are no records left)
prev	string	false	The pointer to fetch previous set of records (null if there are no records left)
results	[responses.TransactionResponse]	false	List of transaction responses

responses.GetTransfersResponse

{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "amount": "100",
      "bridge": "STARKGATE",
      "created_at": 1681497002041,
      "external_account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "external_chain": "ETHEREUM",
      "external_txn_hash": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
      "failure_reason": "Gas fee too low",
      "id": "123456789",
      "kind": "DEPOSIT",
      "last_updated_at": 1681497002041,
      "socialized_loss_factor": "0",
      "status": "PENDING",
      "token": "USDC",
      "txn_hash": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa"
    }
  ]
}

Properties

Name	Type	Required	Description
next	string	false	The pointer to fetch next set of records (null if there are no records left)
prev	string	false	The pointer to fetch previous set of records (null if there are no records left)
results	[responses.TransferResult]	false	List of transaction responses

responses.InsuranceAccountResp

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "account_value": "136285.069",
  "settlement_asset": "USDC",
  "updated_at": 1681471234972
}

Properties

Name	Type	Required	Description
account	string	false	Starknet address of the Insurance fund
account_value	string	false	Total account value of insurance fund
settlement_asset	string	false	Settlement Asset for the account
updated_at	integer	false	Account last updated time

responses.LiquidationResp

{
  "created_at": 1697213130097,
  "id": "0x123456789"
}

Properties

Name	Type	Required	Description
created_at	integer	false	Liquidation created at timestamp
id	string	false	Liquidation transaction hash

responses.MarketChainDetails

{
  "collateral_address": "0x1234567890",
  "contract_address": "0x1234567890",
  "fee_account_address": "0x1234567890",
  "fee_maker": "0.01",
  "fee_taker": "0.01",
  "insurance_fund_address": "0x1234567890",
  "liquidation_fee": "0.01",
  "oracle_address": "0x1234567890",
  "symbol": "ETH-USD-PERP"
}

Properties

Name	Type	Required	Description
collateral_address	string	false	Collateral address
contract_address	string	false	Contract address
fee_account_address	string	false	Fee account address
fee_maker	string	false	Maker fee
fee_taker	string	false	Taker fee
insurance_fund_address	string	false	Insurance fund address
liquidation_fee	string	false	Liquidation fee
oracle_address	string	false	Oracle address
symbol	string	false	Market symbol

responses.MarketResp

{
  "asset_kind": "PERP",
  "base_currency": "ETH",
  "chain_details": {
    "collateral_address": "0x1234567890",
    "contract_address": "0x1234567890",
    "fee_account_address": "0x1234567890",
    "fee_maker": "0.01",
    "fee_taker": "0.01",
    "insurance_fund_address": "0x1234567890",
    "liquidation_fee": "0.01",
    "oracle_address": "0x1234567890",
    "symbol": "ETH-USD-PERP"
  },
  "clamp_rate": "0.05",
  "delta1_cross_margin_params": {
    "imf_base": "0.11",
    "imf_factor": "8001",
    "imf_shift": "0.00021",
    "mmf_factor": "0.51"
  },
  "expiry_at": 0,
  "interest_rate": "0.01",
  "market_kind": "cross",
  "max_funding_rate": "0.05",
  "max_funding_rate_change": "0.0005",
  "max_open_orders": 100,
  "max_order_size": "100",
  "max_tob_spread": "0.2",
  "min_notional": "10",
  "open_at": 0,
  "oracle_ewma_factor": "0.2",
  "order_size_increment": "0.001",
  "position_limit": "500",
  "price_bands_width": "0.05",
  "price_feed_id": "GVXRSBjFk6e6J3NbVPXohDJetcTjaeeuykUpbQF8UoMU",
  "price_tick_size": "0.01",
  "quote_currency": "USD",
  "settlement_currency": "USDC",
  "symbol": "ETH-USD-PERP"
}

Properties

Name	Type	Required	Description
asset_kind	string	false	Type of asset
base_currency	string	false	Base currency of the market pair
chain_details	responses.MarketChainDetails	false	Chain details
clamp_rate	string	false	Clamp rate
delta1_cross_margin_params	responses.Delta1CrossMarginParams	false	Delta1 Cross margin parameters
expiry_at	integer	false	Market expiry time
interest_rate	string	false	Interest rate
market_kind	string	false	Type of market - always 'cross'
max_funding_rate	string	false	Max funding rate
max_funding_rate_change	string	false	Max funding rate change
max_open_orders	integer	false	Max open orders
max_order_size	string	false	Maximum order size
max_tob_spread	string	false	The maximum TOB spread allowed to apply funding rate changes
min_notional	string	false	Minimum order size in USD
open_at	integer	false	Market open time in milliseconds
oracle_ewma_factor	string	false	Oracle EWMA factor
order_size_increment	string	false	Minimum size increment for base currency
position_limit	string	false	Position limit
price_bands_width	string	false	Price Bands Width, 0.05 means 5% price deviation allowed from mark price
price_feed_id	string	false	Price feed id. Pyth price account used to price underlying asset
price_tick_size	string	false	Minimum price increment of the market in USD
quote_currency	string	false	Quote currency of the market pair
settlement_currency	string	false	Settlement currency of the market pair
symbol	string	false	Market symbol

responses.MarketSummaryResp

{
  "ask": "30130.15",
  "bid": "30112.22",
  "created_at": 0,
  "funding_rate": "0.3",
  "last_traded_price": "30109.53",
  "mark_price": "29799.70877478",
  "open_interest": "6100048.3",
  "price_change_rate_24h": "0.05",
  "symbol": "BTC-USD-PERP",
  "total_volume": "141341.0424",
  "underlying_price": "29876.3",
  "volume_24h": "47041.0424"
}

Properties

Name	Type	Required	Description
ask	string	false	Best ask price
bid	string	false	Best bid price
created_at	integer	false	Market summary creation time
funding_rate	string	false	8 hour funding rate
last_traded_price	string	false	Last traded price
mark_price	string	false	Mark price
open_interest	string	false	Open interest in base currency
price_change_rate_24h	string	false	Price change rate in the last 24 hours
symbol	string	false	Market symbol
total_volume	string	false	Lifetime total traded volume in USD
underlying_price	string	false	Underlying asset price (spot oracle price)
volume_24h	string	false	24 hour volume in USD

responses.OrderFlag

"REDUCE_ONLY"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	REDUCE_ONLY

responses.OrderInstruction

"GTC"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	GTC
anonymous	POST_ONLY
anonymous	IOC

responses.OrderResp

{
  "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
  "avg_fill_price": "26000",
  "cancel_reason": "NOT_ENOUGH_MARGIN",
  "client_id": "x1234",
  "created_at": 1681493746016,
  "flags": [
    "REDUCE_ONLY"
  ],
  "id": "123456",
  "instruction": "GTC",
  "last_updated_at": 1681493746016,
  "market": "BTC-USD-PERP",
  "price": "26000",
  "published_at": 1681493746016,
  "received_at": 1681493746016,
  "remaining_size": "0",
  "seq_no": 1681471234972000000,
  "side": "BUY",
  "size": "0.05",
  "status": "NEW",
  "stp": "EXPIRE_MAKER",
  "timestamp": 1681493746016,
  "trigger_price": "26000",
  "type": "MARKET"
}

Properties

Name	Type	Required	Description
account	string	false	Account identifier (user's account address)
avg_fill_price	string	false	Average fill price of the order
cancel_reason	string	false	Reason for order cancellation if it was closed by cancel
client_id	string	false	Client id passed on order creation
created_at	integer	false	Order creation time
flags	[responses.OrderFlag]	false	Order flags, allow flag: REDUCE_ONLY
id	string	false	Unique order identifier
instruction	responses.OrderInstruction	false	OrderInstruction (GTC, IOC, POST_ONLY)
last_updated_at	integer	false	Order last update time. No changes once status=CLOSED
market	string	false	Market to which order belongs
price	string	false	Order price. 0 for MARKET orders
published_at	integer	false	Order published to the client time
received_at	integer	false	Order received from the client time
remaining_size	string	false	Remaining size of the order
seq_no	integer	false	Unique increasing number (non-sequential) that is assigned to this order update and changes on every order update. Can be used to deduplicate multiple feeds. WebSocket and REST responses use independently generated seq_no per event.
side	responses.OrderSide	false	Order side
size	string	false	Order size
status	responses.OrderStatus	false	Order status
stp	responses.STPMode	false	Self Trade Prevention mode (EXEPIRE_MAKER, EXPIRE_TAKER, EXPIRE_BOTH)
timestamp	integer	false	Order signature timestamp
trigger_price	string	false	Trigger price for stop order
type	responses.OrderType	false	Order type

responses.OrderSide

"BUY"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	BUY
anonymous	SELL

responses.OrderStatus

"NEW"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	NEW
anonymous	UNTRIGGERED
anonymous	OPEN
anonymous	CLOSED

responses.OrderType

"MARKET"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	MARKET
anonymous	LIMIT
anonymous	STOP_LIMIT
anonymous	STOP_MARKET
anonymous	TAKE_PROFIT_LIMIT
anonymous	TAKE_PROFIT_MARKET
anonymous	STOP_LOSS_MARKET
anonymous	STOP_LOSS_LIMIT

responses.PointsResp

{
  "maker_volume_score": "0",
  "market": "ETH-USD-PERP",
  "market_pool_share": "0.56",
  "pool": "Tier1",
  "previous_updated_at": 1696291100000,
  "program": "Maker",
  "quote_quality": "71.643",
  "sample_ask_quote_quality": "673.746",
  "sample_bid_quote_quality": "82.998",
  "sample_quote_quality": "260.222",
  "score_share": "0.0123",
  "total_accrued_points": "1.234",
  "total_distributed_points": "150.231",
  "total_market_score": "1003.65",
  "updated_at": 1696291200000,
  "wallet_score": "123.45"
}

Properties

Name	Type	Required	Description
maker_volume_score	string	false	Maker volume score (only applicable for Maker program)
market	string	false	Symbol of the market
market_pool_share	string	false	Share of the market from the pool's points
pool	string	false	Pool name, Tier1 (BTC, ETH) or Tier2 (SOL)
previous_updated_at	integer	false	Previous update timestamp in milliseconds
program	string	false	Program name, Maker or Fee
quote_quality	string	false	Quote quality (only applicable for Maker program)
sample_ask_quote_quality	string	false	Sample ask quote quality to assess quote quality on ask side (only applicable for Maker program)
sample_bid_quote_quality	string	false	Sample bid quote quality to assess quote quality on bid side (only applicable for Maker program)
sample_quote_quality	string	false	Sample quote quality calculated from bid and ask quote quality (only applicable for Maker program)
score_share	string	false	Score share of the wallet for this market and program for the current interval
total_accrued_points	string	false	Total points accrued by the wallet for this market and program since the start of the program
total_distributed_points	string	false	Total points distributed across wallets for this market and program since the start of the program
total_market_score	string	false	Total sum of all wallets scores for this market and program
updated_at	integer	false	Last update timestamp in milliseconds
wallet_score	string	false	Wallet score based on which the points share is calculated. This will be the LP Score if program=Maker or Fee Score if program=Fee

responses.PositionResp

{
  "average_entry_price": "29001.34",
  "average_entry_price_usd": "29001.34",
  "cached_funding_index": "1234.3",
  "cost": "-10005.4623",
  "cost_usd": "-10005.4623",
  "id": "1234234",
  "last_fill_id": "1234234",
  "last_updated_at": 1681493939981,
  "leverage": "string",
  "liquidation_price": "string",
  "market": "BTC-USD-PERP",
  "seq_no": 1681471234972000000,
  "side": "SHORT",
  "size": "-0.345",
  "status": "OPEN",
  "unrealized_funding_pnl": "12.234",
  "unrealized_pnl": "-123.23"
}

Properties

Name	Type	Required	Description
average_entry_price	string	false	Average entry price
average_entry_price_usd	string	false	Average entry price in USD
cached_funding_index	string	false	Position cached funding index
cost	string	false	Position cost
cost_usd	string	false	Position cost in USD
id	string	false	Unique string ID for the position
last_fill_id	string	false	Last fill ID to which the position is referring
last_updated_at	integer	false	Position last update time
leverage	string	false	Leverage of the position
liquidation_price	string	false	Liquidation price of the position
market	string	false	Market for position
seq_no	integer	false	Unique increasing number (non-sequential) that is assigned to this position update. Can be used to deduplicate multiple feeds
side	string	false	Position Side : Long or Short
size	string	false	Size of the position with sign (positive if long or negative if short)
status	string	false	Status of Position : Open or Closed
unrealized_funding_pnl	string	false	Unrealized running funding P&L for the position
unrealized_pnl	string	false	Unrealized P&L of the position in the quote asset

Enumerated Values

Property	Value
side	SHORT
side	LONG
status	OPEN
status	CLOSED

responses.ProgramsEligibility

{
  "affiliate": "Pending",
  "fee": "True",
  "maker": "True",
  "referral": "False"
}

Properties

Name	Type	Required	Description
affiliate	string	false	none
fee	string	false	none
maker	string	false	none
referral	string	false	none

responses.ReferralConfigResp

{
  "commission_rate": "0.1",
  "commission_volume_cap": "1000000000",
  "discount_rate": "0.1",
  "discount_volume_cap": "30000000",
  "minimum_volume": "0.123",
  "points_bonus_rate": "0.1",
  "points_bonus_volume_cap": "30000000",
  "referral_type": "Referral"
}

Properties

Name	Type	Required	Description
commission_rate	string	false	Commission rate for the referer
commission_volume_cap	string	false	Volume cap for commission
discount_rate	string	false	Discount rate for the referee
discount_volume_cap	string	false	Volume cap for discount
minimum_volume	string	false	Minimum volume required to be eligible for Program
points_bonus_rate	string	false	Points bonus rate for the referer
points_bonus_volume_cap	string	false	Volume cap for points bonus
referral_type	string	false	Referral type

responses.ReferralsResp

{
  "address": "string",
  "created_at": 1715592690488,
  "referral_code": "maxdegen01",
  "referral_rewards": "0.123",
  "volume_traded": "0.123"
}

Properties

Name	Type	Required	Description
address	string	false	referee address
created_at	integer	false	Joined at timestamp in milliseconds
referral_code	string	false	Referral code used to onboard the referee
referral_rewards	string	false	Total referral commission earned from the fee of referee
volume_traded	string	false	Total volume traded by referee

responses.STPMode

"EXPIRE_MAKER"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	EXPIRE_MAKER
anonymous	EXPIRE_TAKER
anonymous	EXPIRE_BOTH

responses.SystemConfigResponse

{
  "block_explorer_url": "https://voyager.testnet.paradex.trade/",
  "bridged_tokens": [
    {
      "decimals": 0,
      "l1_bridge_address": "string",
      "l1_token_address": "string",
      "l2_bridge_address": "string",
      "l2_token_address": "string",
      "name": "string",
      "symbol": "string"
    }
  ],
  "environment": "local",
  "l1_chain_id": "5",
  "l1_core_contract_address": "0x182FE62c57461d4c5Ab1aE6F04f1D51aA1607daf",
  "l1_operator_address": "0x63e762538C70442758Fd622116d817761c94FD6A",
  "liquidation_fee": "0.20",
  "oracle_address": "0x47c622ce5f7ff7fa17725df596f4f506364e49be0621eb142a75b44ee3689c6",
  "paraclear_account_hash": "0x033434ad846cdd5f23eb73ff09fe6fddd568284a0fb7d1be20ee482f044dabe2",
  "paraclear_account_proxy_hash": "0x3530cc4759d78042f1b543bf797f5f3d647cde0388c33734cf91b7f7b9314a9",
  "paraclear_address": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7554d",
  "paraclear_decimals": 0,
  "partial_liquidation_buffer": "0.2",
  "partial_liquidation_share_increment": "0.05",
  "starknet_chain_id": "SN_CHAIN_ID",
  "starknet_fullnode_rpc_url": "https://pathfinder.api.testnet.paradex.trade/rpc/v0_7",
  "starknet_gateway_url": "https://potc-testnet-02.starknet.io",
  "universal_deployer_address": "0x1f3f9d3f1f0b7f3f9f3f9f3f9f3f9f3f9f3f9f3f"
}

Properties

Name	Type	Required	Description
block_explorer_url	string	false	Block explorer URL for the current SN Instance
bridged_tokens	[responses.BridgedToken]	false	bridged tokens config https://github.com/starknet-io/starknet-addresses/blob/master/bridged_tokens/goerli.json
environment	string	false	Environment of the Paradex Instance
l1_chain_id	string	false	L1 chain ID value
l1_core_contract_address	string	false	Address of Starknet L1 core contract
l1_operator_address	string	false	Address of Starknet L1 operator
liquidation_fee	string	false	Liquidation fee
oracle_address	string	false	Oracle contract address
paraclear_account_hash	string	false	Class hash of the account contract
paraclear_account_proxy_hash	string	false	Proxy hash of the account contract
paraclear_address	string	false	Paraclear contract address
paraclear_decimals	integer	false	none
partial_liquidation_buffer	string	false	Partial liquidation buffer. Account value is supposed to be at least this much above the MMR after partial liquidation
partial_liquidation_share_increment	string	false	Minimum granularity of partial liquidation share. The share is rounded up to the nearest multiple of this value
starknet_chain_id	string	false	Chain ID for the Starknet Instance
starknet_fullnode_rpc_url	string	false	Full node RPC URL from Starknet
starknet_gateway_url	string	false	Feeder Gateway URL from Starknet
universal_deployer_address	string	false	Universal deployer address

responses.SystemStateResponse

{
  "status": "ok"
}

Properties

Name	Type	Required	Description
status	responses.SystemStatus	false	Status of the system

responses.SystemStatus

"ok"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	ok
anonymous	maintenance
anonymous	cancel_only

responses.SystemTimeResponse

{
  "server_time": "1681493415023"
}

Properties

Name	Type	Required	Description
server_time	string	false	Paradex Server time

responses.TradeResult

{
  "created_at": 1681497002041,
  "id": "12345643",
  "market": "BTC-USD-PERP",
  "price": "30001.2",
  "side": "BUY",
  "size": "0.01",
  "trade_type": "FILL"
}

Properties

Name	Type	Required	Description
created_at	integer	false	Unix Millisecond timestamp at which trade was done
id	string	false	Unique Trade ID per TradeType
market	string	false	Market for which trade was done
price	string	false	Trade price
side	responses.OrderSide	false	Taker side
size	string	false	Trade size
trade_type	string	false	Trade type, can be FILL or LIQUIDATION

responses.TradebustResult

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "busted_fill_id": "12342345",
  "created_at": 1681497002041
}

Properties

Name	Type	Required	Description
account	string	false	Starknet Account from which fill was created
busted_fill_id	string	false	Unique string ID of the busted fill
created_at	integer	false	Unix Millis timestamp when bust was created

responses.TraderRole

"TAKER"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	TAKER
anonymous	MAKER

responses.TransactionResponse

{
  "completed_at": 0,
  "created_at": 0,
  "hash": "0x445c05d6bfb899e39338440d199971c4d7f4cde7878ed3888df3f716efb8df2",
  "id": "12342423",
  "state": "ACCEPTED_ON_L1",
  "type": "TRANSACTION_FILL"
}

Properties

Name	Type	Required	Description
completed_at	integer	false	Timestamp from when the transaction was completed
created_at	integer	false	Timestamp from when the transaction was sent to blockchain gateway
hash	string	false	Tx Hash of the settled trade // Hash of the transaction
id	string	false	Unique string ID of the event that triggered the transaction. For example, fill ID or liquidation ID
state	string	false	Status of the transaction on Starknet
type	string	false	Event that triggered the transaction

Enumerated Values

Property	Value
state	ACCEPTED_ON_L1
state	ACCEPTED_ON_L2
state	NOT_RECEIVED
state	RECEIVED
state	REJECTED
state	REVERTED
type	TRANSACTION_FILL
type	TRANSACTION_LIQUIDATE
type	TRANSACTION_SETTLE_MARKET

responses.TransferBridge

""

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous
anonymous	STARKGATE
anonymous	LAYERSWAP
anonymous	RHINOFI

responses.TransferKind

"DEPOSIT"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	DEPOSIT
anonymous	WITHDRAWAL
anonymous	UNWINDING

responses.TransferResult

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "amount": "100",
  "bridge": "STARKGATE",
  "created_at": 1681497002041,
  "external_account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "external_chain": "ETHEREUM",
  "external_txn_hash": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "failure_reason": "Gas fee too low",
  "id": "123456789",
  "kind": "DEPOSIT",
  "last_updated_at": 1681497002041,
  "socialized_loss_factor": "0",
  "status": "PENDING",
  "token": "USDC",
  "txn_hash": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa"
}

TransferResult

Properties

Name	Type	Required	Description
account	string	false	Starknet Account address
amount	string	false	Transferred amount
bridge	responses.TransferBridge	false	Bridge used for the transfer
created_at	integer	false	Unix Millis timestamp transfer was created on L2
external_account	string	false	External chain account address
external_chain	string	false	External chain used for the transfer
external_txn_hash	string	false	Transaction hash on the external chain
failure_reason	string	false	Reason for transfer failure
id	string	false	Transfer auto-generated ID
kind	responses.TransferKind	false	Transfer Kind (DEPOSIT, WITHDRAWAL)
last_updated_at	integer	false	Unix Millis timestamp transfer was last updated on L2
socialized_loss_factor	string	false	Withdrawal's socialized loss factor
status	responses.TransferStatus	false	Transfer External State (PENDING, AVAILABLE, COMPLETED, FAILED)
token	string	false	Transferred token name
txn_hash	string	false	Transaction hash on Paradex chain

responses.TransferStatus

"PENDING"

Properties

Name	Type	Required	Description
anonymous	string	false	none

Enumerated Values

Property	Value
anonymous	PENDING
anonymous	AVAILABLE
anonymous	COMPLETED
anonymous	FAILED

WebSocket JSON-RPC API

Server URLs

Testnet (Goerli) URL: wss://ws.api.testnet.paradex.trade/v1
Mainnet URL: wss://ws.api.prod.paradex.trade/v1

Establish a WebSocket connection

To establish a WebSocket (WSS) connection on the command line shell, make sure you have NodeJS installed locally before trying.

When running Python-based code, Python 3.10+ is recommended.

Maintaining a WebSocket connection

Paradex has implemented the notion of ping/pong into our code which is a part of the Websocket spec. This works on the protocol level by either the server or the client sending a ping message and waiting for a pong to be received in order to maintain the connection. For Paradex specifically, we have implemented this server side. A ping is sent every 55s and our server expects to receive a pong in the 5s after sending this. Upon receiving the pong the connection will be renewed for 60s. The payload for the pong does not require a specific payload

If our server does not receive the pong within the 5s window, the connection will be terminated

Since this is an integrated part of the websocket spec, you will most likely not need to do anything for this to work. Most libraries and frameworks already have built-in handling of pings which sends pongs automatically in response.

If you are using older libraries or building a WS client from scratch, you may need to listen for these ping messages and send a pong in response.

To display incoming ping messages following wscat command can be used: wscat -P -w 120 -c wss://ws.api.testnet.paradex.trade/v1 -x '{"id":1,"jsonrpc":"2.0","method":"subscribe","params":{"channel":"markets_summary"}}' | grep "ping"

Install dependencies

pip install websocket-client

npm install -g wscat

Test a WebSocket connection

import websocket
import json

websocket_url = "wss://ws.api.testnet.paradex.trade/v1"

# Define a callback to check connection success
def on_open(ws):
    print('Connected')

# Connect to the WebSocket server
ws = websocket.WebSocketApp(websocket_url, on_open=on_open)

# Wait for a response
ws.run_forever()

wscat -c wss://ws.api.testnet.paradex.trade/v1

Successful connection

Connected

Connected (press CTRL+C to quit)

Public vs Private channels

Public channels publish information about exchange that is not specific to a particular account. For example: market summary, order book, trades, etc. You do not need to authenticate your account to subscribe to public channels. Private channels publish information about a particular account. You need to authenticate to subscribe to private channels.

Authenticate the WebSocket connection

`auth`

Authenticating before subscribing to channels

import websocket
import json

websocket_url = "wss://ws.api.testnet.paradex.trade/v1"

# Define the message to send
message = {
  "jsonrpc": "2.0",
  "method": "auth",
  "params": {
    "bearer": "JWcgwMbK0bx1uFFef0Lri35ZDwypmCG0isuBv"
  },
  "id": 0
}

# Define a callback to check connection success
def on_open(ws):
    # Send the message
    ws.send(json.dumps(message))

# Define a callback to handle the response
def on_message(ws, message):
    response = json.loads(message)
    print(response)

# Connect to the WebSocket server
ws = websocket.WebSocketApp(websocket_url, on_open=on_open, on_message=on_message)

# Wait for a response
ws.run_forever()

wscat -c wss://ws.api.testnet.paradex.trade/v1
> Connected (press CTRL+C to quit)
> {
  "jsonrpc": "2.0",
  "method": "auth",
  "params": {
    "bearer": "JWcgwMbK0bx1uFFef0Lri35ZDwypmCG0isuBv"
  },
  "id": 0
}

Example Response

{
  "jsonrpc": "2.0",
  "result": {},
  "usIn": 1682556415569005368,
  "usDiff":1291796,
  "id": 0
}

< {
  "jsonrpc": "2.0",
  "result": {},
  "usIn": 1682556415569005368,
  "usDiff":1291796,
  "id": 0
}

Authentication is required in order to subscribe to private channels.
The JWT (bearer) string is obtained from the POST /auth endpoint.

Note: After the initial authentication, users do not need to re-authenticate their WebSocket connection for the lifetime of the connection.

Params

Param	Type	Description	Required
`bearer`	string	JWT string	Yes

Result

Empty

`subscribe`

Subscribing to trades.ETH-USD-PERP channel

import websocket
import json

websocket_url = "wss://ws.api.testnet.paradex.trade/v1"

# Define the message to send
auth = {
  "jsonrpc": "2.0",
  "method": "auth",
  "params": {
    "bearer": "JWcgwMbK0bx1uFFef0Lri35ZDwypmCG0isuBv"
  },
  "id": 0
}
message = {
  "jsonrpc": "2.0",
  "method": "subscribe",
  "params": {
    "channel": "trades.ETH-USD-PERP"
  },
  "id": 1
}

# Define a callback to check connection success
def on_open(ws):
    # Auth first
    ws.send(json.dumps(auth))
    # Send the message
    ws.send(json.dumps(message))

# Define a callback to handle the response
def on_message(ws, message):
    response = json.loads(message)
    print(response)

# Connect to the WebSocket server
ws = websocket.WebSocketApp(websocket_url, on_open=on_open, on_message=on_message)

# Wait for a response
ws.run_forever()

wscat -c wss://ws.api.testnet.paradex.trade/v1
> Connected (press CTRL+C to quit)
> {
  "jsonrpc": "2.0",
  "method": "subscribe",
  "params": {
    "channel": "trades.ETH-USD-PERP"
  },
  "id": 1
}

Example response

{
  "jsonrpc": "2.0",
  "result": {
    "channel": "trades.ETH-USD-PERP"
  },
  "usIn": 1682556415569005368,
  "usDiff":1291796,
  "id": 1
}

< {
  "jsonrpc": "2.0",
  "result": {
    "channel": "trades.ETH-USD-PERP"
  },
  "usIn": 1682556415569005368,
  "usDiff":1291796,
  "id": 1
}

Multiple calls to subscribe can be made, each for a different channel.

Subscribing to the same channel more than once will return an error.

Refer to the WebSocket Channels documentation for a list of supported channels.

Params

Param	Type	Description	Required
`channel`	string	Channel name	Yes

Result

Param	Type	Description	Required
`channel`	string	Channel name	Yes

Unsubscribe from a WebSocket channel

`unsubscribe`

Unsubscribing from trades.ETH-USD-PERP channel

import websocket
import json

websocket_url = "wss://ws.api.testnet.paradex.trade/v1"

# Define the message to send
auth = {
  "jsonrpc": "2.0",
  "method": "auth",
  "params": {
    "bearer": "JWcgwMbK0bx1uFFef0Lri35ZDwypmCG0isuBv"
  },
  "id": 0
}
message = {
  "jsonrpc": "2.0",
  "method": "unsubscribe",
  "params": {
    "channel": "trades.ETH-USD-PERP"
  },
  "id": 2
}

# Define a callback to check connection success
def on_open(ws):
    # Auth first
    ws.send(json.dumps(auth))
    # Send the message
    ws.send(json.dumps(message))

# Define a callback to handle the response
def on_message(ws, message):
    response = json.loads(message)
    print(response)

# Connect to the WebSocket server
ws = websocket.WebSocketApp(websocket_url, on_open=on_open, on_message=on_message)

# Wait for a response
ws.run_forever()

wscat -c wss://ws.api.testnet.paradex.trade/v1
> Connected (press CTRL+C to quit)
> {
  "jsonrpc": "2.0",
  "method": "unsubscribe",
  "params": {
    "channel": "trades.ETH-USD-PERP"
  },
  "id": 2
}

Example response

{
  "jsonrpc": "2.0",
  "result": {
    "channel": "trades.ETH-USD-PERP"
  },
  "usIn": 1682556415569005368,
  "usDiff":1291796,
  "id": 2
}

< {
  "jsonrpc": "2.0",
  "result": {
    "channel": "trades.ETH-USD-PERP"
  },
  "usIn": 1682556415569005368,
  "usDiff":1291796,
  "id": 2
}

Unsubscribing from a channel that you are not subscribed to will return an error.

Params

Param	Type	Description	Required
`channel`	string	Channel name	Yes

Result

Param	Type	Description	Required
`channel`	string	Channel name	Yes

WebSocket error codes

Sample error

{
  "jsonrpc": "2.0",
  "error": { 
    "code": -32601, 
    "message": "method does not exist" 
  },
  "usIn": 1710522972729581,
  "usOut": 1710522972729618
  "usDiff": 37,
  "id": 4,
}

{
  "jsonrpc": "2.0",
  "error": { 
    "code": -32601, 
    "message": "method does not exist" 
  },
  "usIn": 1710522972729581,
  "usOut": 1710522972729618
  "usDiff": 37,
  "id": 4,
}

< {
  "jsonrpc": "2.0",
  "error": { 
    "code": -32601, 
    "message": "method does not exist" 
  },
  "usIn": 1710522972729581,
  "usOut": 1710522972729618
  "usDiff": 37,
  "id": 4,
}

{
  "jsonrpc": "2.0",
  "error": { 
    "code": -32601, 
    "message": "method does not exist" 
  },
  "usIn": 1710522972729581,
  "usOut": 1710522972729618
  "usDiff": 37,
  "id": 4,
}

RPC calls can respond with errors. Error details come in the error property.

Error

Param	Type	Description	Required
`code`	number	Error code	Yes
`message`	string	Short explanation	Yes
`data`	string	Extra details	No

Error codes

Code	Description
`-32700`	Parse error
`-32600`	Invalid request
`-32601`	Method not found
`-32602`	Invalid parameterss
`-32603`	Internal error
`100`	Method error
`40110`	Malformed Bearer Token
`40111`	Invalid Bearer Token
`40112`	Geo IP blocked

Error codes from -32768 to -32000 are pre-defined errors per the JSON-RPC specification. Other errors are Paradex WS API specific.

WebSocket channels documentation

Channels that can be subscribed to to get real time updates by using subscribe.

Operations

SUB `orders.{market_symbol}` Operation

Private websocket channel to receive order updates

Parameters

Name	Type	Description	Value	Constraints	Notes
market_symbol	string	Either the symbol of the market (any open market returned by `GET /markets`) or `"ALL"` to subscribe for updates to all markets	-	-	required

Message Order (Private) `order`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are NOT allowed
account	string	Account identifier (user's account address)	-	-	-
cancel_reason	string	Reason for order cancellation if it was closed by cancel	allowed (`"USER_CANCELED"`, `"NOT_ENOUGH_MARGIN"`, `"EMPTY_MARKET"`, `"POST_ONLY_WOULD_CROSS"`, `"REMAINING_IOC_CANCEL"`, `"UNEXPECTED_FAILURE"`, `"DELEVERAGE"`, `"IN_LIQUIDATION"`, `"SELF_TRADE"`, `"ASSET_UNAVAILABLE"`, `"ASSET_EXPIRED"`, `"MARKET_NOT_OPEN"`, `"ORDER_TYPE_INVALID"`, `"PRICE_NOT_AVAILABLE"`, `"EXPIRED"`, `"PRICE_OUTSIDE_BANDS"`, `"TIMEOUT"`, `"ORDER_EXCEEDS_POSITION_LIMIT"`, `"REDUCE_ONLY_WILL_INCREASE"`)	-	-
client_id	string	Client id passed on order creation	-	-	-
created_at	integer	Order creation time in milliseconds	-	-	-
id	string	Unique order identifier assigned by exchange	-	-	-
instruction	string	Order instruction type, either "GTC", "IOC", or "POST_ONLY"	allowed (`"GTC"`, `"POST_ONLY"`, `"IOC"`)	-	-
last_updated_at	integer	Order last update time in milliseconds. No changes once status=CLOSED	-	-	-
market	string	Symbol of the market	-	-	-
price	string	Order limit price	-	-	-
remaining_size	string	Remaining size of the order	-	-	-
side	string	Order side	allowed (`"BUY"`, `"SELL"`)	-	-
size	string	Order size	-	-	-
status	string	Order status	allowed (`"NEW"`, `"OPEN"`, `"CLOSED"`)	-	-
timestamp	number	-	-	format (`Unix Timestamp (ms)`)	-
type	string	Order type	allowed (`"MARKET"`, `"LIMIT"`, `"STOP_MARKET"`, `"STOP_LIMIT"`)	-	-
seq_no	integer	Sequence number of the order updates. WebSocket and REST responses use independently generated seq_no per event.	-	-	-
avg_fill_price	string	Average fill price of the order	-	-	-
received_at	integer	Order received time in milliseconds	-	-	-
published_at	integer	Order published time in milliseconds	-	-	-
flags	array	Order flags	-	-	-
flags (single item)	string	-	-	-	-
trigger_price	string	Trigger price for stop order	-	-	-

Examples of payload (generated)

{
  "account": "0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x",
  "cancel_reason": "USER_CANCELED",
  "client_id": "x1234",
  "created_at": 1696291200000,
  "id": "123456",
  "instruction": "GTC",
  "last_updated_at": 1696291200000,
  "market": "string",
  "price": "26000.5",
  "remaining_size": "0",
  "side": "BUY",
  "size": "0.05",
  "status": "NEW",
  "timestamp": 1681462770114,
  "type": "MARKET",
  "seq_no": 20784,
  "avg_fill_price": "26000",
  "received_at": 1696291200000,
  "published_at": 1696291200000,
  "flags": [
    "string"
  ],
  "trigger_price": "26000.5"
}

SUB `tradebusts` Operation

Private websocket channel to receive fills that are busted by a blockchain

Message Trade Bust `trade_bust`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Tradebust details	-	-	additional properties are NOT allowed
account	string	Starknet Account from which fill was created	-	-	-
busted_fill_id	string	Unique string ID of the busted fill	-	-	-
created_at	integer	Bust creation time in milliseconds	-	-	-

Examples of payload (generated)

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "busted_fill_id": "12342345",
  "created_at": 1696291200000
}

SUB `fills.{market_symbol}` Operation

Private websocket channel to receive details of fills for specific account

Parameters

Name	Type	Description	Value	Constraints	Notes
market_symbol	string	Either the symbol of the market (any open market returned by `GET /markets`) or `"ALL"` to subscribe for updates to all markets	-	-	required

Message Fill `fill`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Fill Details	-	-	additional properties are NOT allowed
client_id	string	Unique client assigned ID for the order.	-	-	-
created_at	integer	Fill time in milliseconds.	-	-	-
fee	string	Fee paid by the user in fee_currency	-	-	-
fee_currency	string	Asset that fee is charged in	allowed (`"USDC"`)	-	-
id	string	Unique ID of the fill	-	-	-
liquidity	string	Maker or Taker	allowed (`"TAKER"`, `"MAKER"`)	-	-
market	string	Symbol of the market	-	-	-
order_id	string	Order ID assigned by exchange	-	-	-
price	string	Price at which order was filled	-	-	-
side	string	Order side	allowed (`"BUY"`, `"SELL"`)	-	-
size	string	Size of the fill	-	-	-
remaining_size	string	Remaining size of the order	-	-	-
seq_no	integer	Sequence number of the fill	-	-	-
fill_type	string	Type of fill	allowed (`"FILL"`, `"LIQUIDATION"`)	-	-

Examples of payload (generated)

{
  "client_id": "x1234",
  "created_at": 1696291200000,
  "fee": "7.56",
  "fee_currency": "USDC",
  "id": "8615262148007718462",
  "liquidity": "TAKER",
  "market": "string",
  "order_id": "1681462103821101699438490000",
  "price": "30000.12",
  "side": "BUY",
  "size": "0.5",
  "remaining_size": "0.7",
  "seq_no": 20784,
  "fill_type": "FILL"
}

SUB `positions` Operation

Private websocket channel to receive updates when position is changed

Message Position `position`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Position details	-	-	additional properties are NOT allowed
average_entry_price	string	Average entry price in USDC	-	-	-
average_entry_price_usd	string	Average entry price in USD	-	-	-
cached_funding_index	string	Position cached funding index	-	-	-
cost	string	Position cost in USDC	-	-	-
cost_usd	string	Position cost in USD	-	-	-
id	string	Unique string ID for the position	-	-	-
last_fill_id	string	Last fill ID to which the position is referring	-	-	-
last_updated_at	integer	Position last update time in milliseconds	-	-	-
market	string	Symbol of the market	-	-	-
side	string	Position Side: Long or Short	allowed (`"LONG"`, `"SHORT"`)	-	-
size	string	Size of the position with sign (positive or negative)	-	-	-
status	string	Status of Position: Open or Closed	allowed (`"OPEN"`, `"CLOSED"`)	-	-
unrealized_funding_pnl	string	Unrealized funding P&L for the position in a quote currency (USD)	-	-	-
unrealized_pnl	string	Unrealized P&L of the position in a quote currency (USD)	-	-	-
seq_no	integer	Sequence number of the position updates	-	-	-
liquidation_price	string	Liquidation price of the position	-	-	-
leverage	string	Leverage of the position	-	-	-

Examples of payload (generated)

{
  "average_entry_price": "29001.34",
  "average_entry_price_usd": "29000.34",
  "cached_funding_index": "1234.3",
  "cost": "1234.3",
  "cost_usd": "1234.1",
  "id": "1234234",
  "last_fill_id": "1234234",
  "last_updated_at": 1696291200000,
  "market": "string",
  "side": "LONG",
  "size": "-0.345",
  "status": "OPEN",
  "unrealized_funding_pnl": "12.234",
  "unrealized_pnl": "-123.23",
  "seq_no": 20784,
  "liquidation_price": "string",
  "leverage": "12.234"
}

SUB `funding_data.{market_symbol}` Operation

Public websocket channel to receive funding data updates

Parameters

Name	Type	Description	Value	Constraints	Notes
market_symbol	string	Either the symbol of the market (any open market returned by `GET /markets`) or `"ALL"` to subscribe for updates to all markets	-	-	required

Message Funding Data `funding_data`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Funding Data details	-	-	additional properties are NOT allowed
market	string	Symbol of the market	-	-	-
funding_index	string	Current Funding Index	-	-	-
funding_premium	string	Current Funding Premium: (Mark Price - Spot Price) / USDC Price	-	-	-
funding_rate	string	Current 8hr Funding Rate: (Mark Price - Spot Price) / Spot Price	-	-	-
created_at	integer	Funding payments time in milliseconds	-	-	-

Examples of payload (generated)

{
  "market": "string",
  "funding_index": "100.0",
  "funding_premium": "22.4",
  "funding_rate": "0.00034",
  "created_at": 1696291200000
}

SUB `funding_payments.{market_symbol}` Operation

Private websocket channel to receive funding payments of an account

Parameters

Name	Type	Description	Value	Constraints	Notes
market_symbol	string	Either the symbol of the market (any open market returned by `GET /markets`) or `"ALL"` to subscribe for updates to all markets	-	-	required

Message Funding Payments `funding_payments`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Funding Payments details	-	-	additional properties are NOT allowed
id	string	Unique string ID for the funding payment	-	-	-
market	string	Symbol of the market	-	-	-
payment	string	Funding Payment in settlement currency	-	-	-
index	string	Funding Index at the moment of payment	-	-	-
fill_id	string	Unique string ID of the fill that triggered the funding payment	-	-	-
created_at	integer	Funding payment time in milliseconds	-	-	-

Examples of payload (generated)

{
  "id": "1234234",
  "market": "string",
  "payment": "-0.00692314",
  "index": "9.17272552",
  "fill_id": "12342345",
  "created_at": 1696291200000
}

SUB `markets_summary` Operation

Public websocket channel for updates of available markets

Message Market Summary `market_summary`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Market Summary details	-	-	additional properties are NOT allowed
symbol	string	Symbol of the market	-	-	-
mark_price	string	Computed oracle (Mark) Price for the market	-	-	-
last_traded_price	string	Last traded price for the market	-	-	-
bid	string	Best Bid price	-	-	-
ask	string	Best Ask price	-	-	-
volume_24	string	Last 24 hour volume in USD	-	-	-
total_volume	any	Lifetime total traded volume for the market in USD	-	-	additional properties are allowed
created_at	integer	Market summary creation time in milliseconds	-	-	-
underlying_price	string	Underlying asset (spot oracle) price	-	-	-
open_interest	string	Open interest in base currency	-	-	-
funding_rate	string	8hr Funding Rate	-	-	-
price_change_rate_24h	string	Price change rate in the last 24 hours	-	-	-

Examples of payload (generated)

{
  "symbol": "string",
  "mark_price": "29799.70877478",
  "last_traded_price": "30109.53",
  "bid": "30112.22",
  "ask": "30130.15",
  "volume_24": "47041.0424",
  "total_volume": "141341.0424",
  "created_at": 1696291200000,
  "underlying_price": "1878.41",
  "open_interest": "182.571",
  "funding_rate": "0.3",
  "price_change_rate_24h": "0.03"
}

SUB `account` Operation

Private websocket channel for receiving updates of account status

Message Account `account`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Account details	-	-	additional properties are NOT allowed
account	string	User's starknet account	-	-	-
account_value	string	Current account value [including unrealized P&Ls] in quote currency (USD)	-	-	-
free_collateral	string	Account value in excess of Initial Margin requirement in quote currency (USD)	-	-	-
initial_margin_requirement	string	Amount of collateral (in USD) required to open the existing positions	-	-	-
maintenance_margin_requirement	string	Amount of collateral (in USD) required to maintain existing positions	-	-	-
margin_cushion	string	Account value in excess of maintenance margin required (in USD)	-	-	-
settlement_asset	string	Settlement asset for the account	allowed (`"USDC"`)	-	-
status	string	Status of the account	allowed (`"ACTIVE"`, `"DELEVERAGE"`, `"LIQUIDATION"`)	-	-
total_collateral	string	Account's total collateral in quote currency (USD)	-	-	-
updated_at	integer	Account last updated time	-	-	-
seq_no	integer	Sequence number of the account updates	-	-	-

Examples of payload (generated)

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "account_value": "136285.06918911",
  "free_collateral": "73276.47229774",
  "initial_margin_requirement": "63008.59689218",
  "maintenance_margin_requirement": "31597.25239676",
  "margin_cushion": "104687.8167956",
  "settlement_asset": "USDC",
  "status": "ACTIVE",
  "total_collateral": "123003.62047353",
  "updated_at": 1696291200000,
  "seq_no": 20784
}

SUB `trades.{market_symbol}` Operation

Public websocket channel to receive updates on trades in particular market

Parameters

Name	Type	Description	Value	Constraints	Notes
market_symbol	string	Either the symbol of the market (any open market returned by `GET /markets`) or `"ALL"` to subscribe for updates to all markets	-	-	required

Message Trade `trade`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Trade details	-	-	additional properties are NOT allowed
created_at	integer	Trade time in milliseconds	-	-	-
id	string	Unique Trade ID per TradeType	-	-	-
market	string	Symbol of the market	-	-	-
price	string	Trade price	-	-	-
side	string	Which side was a Taker	allowed (`"BUY"`, `"SELL"`)	-	-
size	string	Trade size	-	-	-
trade_type	string	Type of trade	allowed (`"FILL"`, `"LIQUIDATION"`)	-	-

Examples of payload (generated)

{
  "created_at": 1696291200000,
  "id": "12345643",
  "market": "string",
  "price": "30001.2",
  "side": "BUY",
  "size": "0.01",
  "trade_type": "FILL"
}

SUB `transaction` Operation

Private websocket channel for receiving transaction details of fills

Message Transaction `transaction`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Transaction details	-	-	additional properties are NOT allowed
completed_at	integer	Transaction completion time in milliseconds	-	-	-
created_at	integer	Transaction being sent to blockchain gateway timestamp in milliseconds	-	-	-
hash	string	Tx Hash of the settled trade	-	-	-
id	string	Unique string ID of the event that triggered the transaction. For example, fill ID or liquidation ID	-	-	-
state	string	Status of the transaction on Starknet	allowed (`"ACCEPTED_ON_L1"`, `"ACCEPTED_ON_L2"`, `"NOT_RECEIVED"`, `"PENDING"`, `"RECEIVED"`, `"REJECTED"`, `"REVERTED"`)	-	-
type	string	Event that triggered the transaction	allowed (`"TRANSACTION_FILL"`, `"TRANSACTION_LIQUIDATE"`, `"TRANSACTION_SETTLE_MARKET"`)	-	-

Examples of payload (generated)

{
  "completed_at": 1696291200000,
  "created_at": 1696291200000,
  "hash": "0x445c05d6bfb899e39338440d199971c4d7f4cde7878ed3888df3f716efb8df2",
  "id": "12342423",
  "state": "ACCEPTED_ON_L1",
  "type": "TRANSACTION_FILL"
}

SUB `transfers` Operation

Websocket channel for receiving transfer updates

Meaning of each transfer status:

PENDING: L2 txn calling Paraclear contract is in flight: For Withdrawals it's the initial status; refers to the L2 txn status being RECEIVED, PENDING, ACCEPTED_ON_L2. For Deposits refers to L2 txn status being RECEIVED, PENDING.
AVAILABLE: Action is required from user: For Withdrawals refers to L2 txn status being ACCEPTED_ON_L1 and funds available for collection on Ethereum bridge. For Deposits refers to funds being available in the L2 account, ready to be deposited to Paraclear contract.
COMPLETED: Transfer has completed (final state): For Withdrawals funds have been collected and have moved to the requested Ethereum account; refers to L1 bridge withdraw txn status SUCCESS. For Deposits funds have become available in Paradex; refers to the L2 txn status being ACCEPTED_ON_L2.
FAILED: L2 txn calling Paraclear contract failed with REJECTED status. Deposits can be retried when they fail by repeating the L2 txn.

Message Transfer `transfer`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Transfer details	-	-	additional properties are NOT allowed
account	string	User's starknet account	-	-	-
amount	string	Transfer amount	-	-	-
created_at	integer	Transfer creation timestamp in milliseconds	-	-	-
id	string	Unique string ID of the transfer	-	-	-
kind	string	Kind of tansfer	allowed (`"DEPOSIT"`, `"WITHDRAWAL"`)	-	-
last_updated_at	integer	Timestamp of the last update of transfer status (in milliseconds)	-	-	-
token	string	Token	allowed (`"USDC"`)	-	-
txn_hash	string	Transaction hash on Paradex chain	-	-	-
external_txn_hash	string	Transaction hash on the external chain	-	-	-
status	string	Status of the transfer	allowed (`"PENDING"`, `"AVAILABLE"`, `"COMPLETED"`, `"FAILED"`)	-	-
socialized_loss_factor	string	Socialized loss factor, ratio of funds withheld on withdrawal	-	-	-

Examples of payload (generated)

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "amount": "100000",
  "created_at": 1696291200000,
  "id": "123456789",
  "kind": "DEPOSIT",
  "last_updated_at": 1696291200000,
  "token": "USDC",
  "txn_hash": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "external_txn_hash": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "status": "PENDING",
  "socialized_loss_factor": "0.0001"
}

SUB `order_book.{market_symbol}.snapshot@15@{refresh_rate}` Operation

Public websocket channel for orderbook snapshot updates of depth 15 at most every 50ms or 100ms

Parameters

Name	Type	Description	Value	Constraints	Notes
market_symbol	string	Symbol of the market (any open market returned by `GET /markets`)	-	-	required
refresh_rate	string	Rate of sending updates	allowed (`"50ms"`, `"100ms"`)	-	required

Message Order Book Snapshot `order_book.snapshot`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	The entire order book	examples (`{"seq_no":20784,"market":"ETH-USD-PERP","last_updated_at":1681462770100,"update_type":"s","deletes":[],"inserts":[{"side":"BUY","price":"1908.2","size":"69.379"},{"side":"BUY","price":"1908.18","size":"16.569"},{"side":"SELL","price":"1909.16","size":"18.465"},{"side":"SELL","price":"1909.89","size":"8.144"}],"updates":[]}`, `{"seq_no":20785,"market":"ETH-USD-PERP","last_updated_at":1681462770200,"update_type":"s","deletes":[],"inserts":[{"side":"BUY","price":"1908.2","size":"60.379"},{"side":"BUY","price":"1908.18","size":"10.569"},{"side":"SELL","price":"1909.16","size":"10.465"},{"side":"SELL","price":"1909.89","size":"5.144"}],"updates":[]}`)	-	additional properties are NOT allowed
seq_no	integer	Sequence number of the orderbook snapshots	-	-	-
market	string	Symbol of the market	-	-	-
last_updated_at	integer	Last orderbook update time in milliseconds	-	-	-
update_type	string	The type of update message is always `s`.	allowed (`"s"`)	-	-
deletes	array	Always an empty array.	-	<= 0 items	required
inserts	array	An array of price levels representing the order book at the requested depth.	-	-	required
inserts.side	string	-	allowed (`"BUY"`, `"SELL"`)	-	-
inserts.price	string	-	-	>= 0	-
inserts.size	string	-	-	>= 0	-
updates	array	Always an empty array.	-	<= 0 items	required

Examples of payload

{
  "seq_no": 20784,
  "market": "ETH-USD-PERP",
  "last_updated_at": 1681462770100,
  "update_type": "s",
  "deletes": [],
  "inserts": [
    {
      "side": "BUY",
      "price": "1908.2",
      "size": "69.379"
    },
    {
      "side": "BUY",
      "price": "1908.18",
      "size": "16.569"
    },
    {
      "side": "SELL",
      "price": "1909.16",
      "size": "18.465"
    },
    {
      "side": "SELL",
      "price": "1909.89",
      "size": "8.144"
    }
  ],
  "updates": []
}

{
  "seq_no": 20785,
  "market": "ETH-USD-PERP",
  "last_updated_at": 1681462770200,
  "update_type": "s",
  "deletes": [],
  "inserts": [
    {
      "side": "BUY",
      "price": "1908.2",
      "size": "60.379"
    },
    {
      "side": "BUY",
      "price": "1908.18",
      "size": "10.569"
    },
    {
      "side": "SELL",
      "price": "1909.16",
      "size": "10.465"
    },
    {
      "side": "SELL",
      "price": "1909.89",
      "size": "5.144"
    }
  ],
  "updates": []
}

SUB `order_book.{market_symbol}.deltas` Operation

Public websocket channel for incremental updates of orderbook for the subscribed market. The first message contains the latest snapshot of the entire orderbook, with consequent messages providing the orderbook level deltas (L2 data). Together with a sequence number seq_no, it should be enough to construct a history of the orderbook since connection established.

Parameters

Name	Type	Description	Value	Constraints	Notes
market_symbol	string	Symbol of the market (any open market returned by `GET /markets`)	-	-	required

Message Order Book Deltas `order_book.delta`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	The order book deltas (L2)	examples (`{"seq_no":20784,"market":"ETH-USD-PERP","last_updated_at":1681462770114,"update_type":"s","deletes":[],"inserts":[{"side":"BUY","price":"1908.2","size":"69.379"},{"side":"BUY","price":"1908.18","size":"16.569"},{"side":"SELL","price":"1909.16","size":"18.465"},{"side":"SELL","price":"1909.89","size":"8.144"}],"updates":[]}`, `{"seq_no":20785,"market":"ETH-USD-PERP","last_updated_at":1681462770115,"update_type":"d","deletes":[{"side":"SELL","price":"1909.16","size":"0"}],"inserts":[],"updates":[{"side":"BUY","price":"1908.2","size":"42.95"}]}`)	-	additional properties are NOT allowed
seq_no	integer	Sequence number of the orderbook deltas	-	-	-
market	string	Symbol of the market	-	-	-
last_updated_at	integer	Last orderbook update time in milliseconds	-	-	-
update_type	string	The type of update message this is. `s` denotes the first message with the full state of orderbook whereas `d` denotes the book delta from the previous `seq_no`.	allowed (`"s"`, `"d"`)	-	-
deletes	array	An array of price levels that are no longer in the orderbook. Empty if `update_type` is `s`.	-	-	required
deletes.side	string	-	allowed (`"BUY"`, `"SELL"`)	-	-
deletes.price	string	-	-	>= 0	-
deletes.size	string	-	-	>= 0	-
inserts	array	An array of price levels that were added to the orderbook.	-	-	required
inserts.side	string	-	allowed (`"BUY"`, `"SELL"`)	-	-
inserts.price	string	-	-	>= 0	-
inserts.size	string	-	-	>= 0	-
updates	array	An array of price level updates (including new levels). Empty if `update_type` is `s`.	-	-	required
updates.side	string	-	allowed (`"BUY"`, `"SELL"`)	-	-
updates.price	string	-	-	>= 0	-
updates.size	string	-	-	>= 0	-

Examples of payload

{
  "seq_no": 20784,
  "market": "ETH-USD-PERP",
  "last_updated_at": 1681462770114,
  "update_type": "s",
  "deletes": [],
  "inserts": [
    {
      "side": "BUY",
      "price": "1908.2",
      "size": "69.379"
    },
    {
      "side": "BUY",
      "price": "1908.18",
      "size": "16.569"
    },
    {
      "side": "SELL",
      "price": "1909.16",
      "size": "18.465"
    },
    {
      "side": "SELL",
      "price": "1909.89",
      "size": "8.144"
    }
  ],
  "updates": []
}

{
  "seq_no": 20785,
  "market": "ETH-USD-PERP",
  "last_updated_at": 1681462770115,
  "update_type": "d",
  "deletes": [
    {
      "side": "SELL",
      "price": "1909.16",
      "size": "0"
    }
  ],
  "inserts": [],
  "updates": [
    {
      "side": "BUY",
      "price": "1908.2",
      "size": "42.95"
    }
  ]
}

SUB `bbo.{market_symbol}` Operation

Public websocket channel for tick updates of orderbook best bid/ask prices and amounts

Parameters

Name	Type	Description	Value	Constraints	Notes
market_symbol	string	Symbol of the market (any open market returned by `GET /markets`)	-	-	required

Message BBO `bbo`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
market	string	Symbol of the market	-	-	required
bid	string	Current Best Bid price	-	-	required
bid_size	string	Current Best Bid size	-	-	required
ask	string	Current Best Ask price	-	-	required
ask_size	string	Current Best Ask size	-	-	required
last_updated_at	integer	Last orderbook update time in milliseconds	-	-	required

Examples of payload (generated)

{
  "market": "string",
  "bid": "30112.22",
  "bid_size": "100",
  "ask": "31130.15",
  "ask_size": "200",
  "last_updated_at": 1696291200000
}

SUB `balance_events` Operation

Private websocket channel to receive PnL calculation data

Message Balance Event `balance_event`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are NOT allowed
type	string	The type of the balance event	allowed (`"TRANSACTION_FILL"`)	-	-
fill_id	string	Unique string ID of the fill that triggered the balance event	-	-	-
market	string	Symbol of the market	-	-	-
status	string	Status of the Fill	allowed (`"ON_BLOCKCHAIN"`)	-	-
settlement_asset_balance_before	string	Balance of the settlement asset before the balance event (USDC)	-	-	-
settlement_asset_balance_after	string	Balance of the settlement asset after the balance event (USDC)	-	-	-
settlement_asset_price	string	Settlement asset price (USD)	-	-	-
funding_index	string	Current Funding Index	-	-	-
realized_pnl	string	Realized P&L for the user position	-	-	-
fees	string	Fees paid by the user in fee_currency (USDC)	-	-	-
realized_funding	string	Realized funding P&L for the position in a quote currency (USDC)	-	-	-
created_at	integer	Unix Millisecond timestamp at which the event occurred	-	-	-

Examples of payload (generated)

{
  "type": "TRANSACTION_FILL",
  "fill_id": "12342345",
  "market": "string",
  "status": "ON_BLOCKCHAIN",
  "settlement_asset_balance_before": "1000",
  "settlement_asset_balance_after": "2000",
  "settlement_asset_price": "1.001",
  "funding_index": "0.123",
  "realized_pnl": "12.34",
  "fees": "0.42",
  "realized_funding": "0.444",
  "created_at": 1696291200000
}

SUB `points_data.{market_symbol}.{program_name}` Operation

Private websocket to receive points data updates

Parameters

Name	Type	Description	Value	Constraints	Notes
market_symbol	string	Either the symbol of the market (any open market returned by `GET /markets`) or `"ALL"` to subscribe for updates to all markets	-	-	required
program_name	string	Name of the program to subscribe to for updates	allowed (`"Maker"`, `"Fee"`)	-	required

Message Points update (Private) `points`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are NOT allowed
program	string	Name of the program	allowed (`"Maker"`, `"Fee"`)	-	-
pool	string	Name of the pool	allowed (`"Tier1"`, `"Tier2"`)	-	-
market	string	Symbol of the market	-	-	-
quote_quality	string	Quote quality (only applicable for Maker program)	-	-	-
sample_ask_quote_quality	string	Sample ask quote quality to assess quote quality on ask side (only applicable for Maker program)	-	-	-
sample_bid_quote_quality	string	Sample bid quote quality to assess quote quality on bid side (only applicable for Maker program)	-	-	-
sample_quote_quality	string	Sample quote quality calculated from bid and ask quote quality (only applicable for Maker program)	-	-	-
maker_volume_score	string	Maker volume score (only applicable for Maker program)	-	-	-
wallet_score	string	Wallet score based on which the points share is calculated. This will be the LP Score if program=Maker or Fee Score if program=Fee	-	-	-
total_market_score	string	Total sum of all wallets scores for this market and program	-	-	-
score_share	string	Score share of the wallet for this market and program for the current interval	-	-	-
market_pool_share	string	Share of the market from the pool's points	-	-	-
total_accrued_points	string	Total points accrued by the wallet for this market and program since the start of the program	-	-	-
total_distributed_points	string	Total points distributed across wallets for this market and program since the start of the program	-	-	-
updated_at	integer	Last update timestamp	-	-	-
previous_updated_at	integer	Previous update timestamp	-	-	-

Examples of payload (generated)

{
  "program": "Maker",
  "pool": "Tier1",
  "market": "string",
  "quote_quality": "71.643",
  "sample_ask_quote_quality": "673.746",
  "sample_bid_quote_quality": "82.998",
  "sample_quote_quality": "260.222",
  "maker_volume_score": "4130.46221867",
  "wallet_score": "0.984124075723888",
  "total_market_score": "1668006.90800659",
  "score_share": "0.00000059",
  "market_pool_share": "0.63520031",
  "total_accrued_points": "18.38593175",
  "total_distributed_points": "144542.3740861",
  "updated_at": 1696291200000,
  "previous_updated_at": 1696291100000
}