Account

Get account information

Respond with requester's account information

GEThttps://api.prod.paradex.trade/v1/account
Authorization
Response

OK

Body
accountstring

User's starknet account

Example: 2.073967317963419e+75
account_valuestring

Current account value [with unrealized P&Ls]

Example: "136285.06918911"
free_collateralstring

Free collateral available (Account value in excess of Initial Margin required)

Example: "73276.47229774"
initial_margin_requirementstring

Amount required to open trade for the existing positions

Example: "63008.59689218"
maintenance_margin_requirementstring

Amount required to maintain exisiting positions

Example: "31597.25239676"
margin_cushionstring

Acc value in excess of maintenance margin required

Example: "104687.8167956"
seq_nointeger

Unique increasing number (non-sequential) that is assigned to this account update. Can be used to deduplicate multiple feeds

Example: 1681471234972000000
settlement_assetstring

Settlement asset for the account

Example: "USDC"
statusstring

Status of the acc - like ACTIVE, LIQUIDATION

Example: "ACTIVE"
total_collateralstring

User's total collateral

Example: "123003.62047353"
updated_atinteger

Account last updated time

Example: 1681471234972
Request
const response = await fetch('https://api.prod.paradex.trade/v1/account', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "account": 2.073967317963419e+75,
  "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
}

Get account profile information

Respond with requester's account information

GEThttps://api.prod.paradex.trade/v1/account/profile
Authorization
Response

OK

Body
is_username_privateboolean
Example: true
programs_eligibilityresponses.ProgramsEligibility (object)
referral_codestring
Example: "cryptofox8"
referred_bystring
Example: "maxDegen"
usernamestring
Example: "username"
Request
const response = await fetch('https://api.prod.paradex.trade/v1/account/profile', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "is_username_private": true,
  "programs_eligibility": {
    "affiliate": "Pending",
    "fee": "True",
    "maker": "True",
    "referral": "False"
  },
  "referral_code": "cryptofox8",
  "referred_by": "maxDegen",
  "username": "username"
}

Updates account profile fields

Respond with requester's account information

POSThttps://api.prod.paradex.trade/v1/account/profile/referral_code
Authorization
Response

OK

Body
is_username_privateboolean
Example: true
programs_eligibilityresponses.ProgramsEligibility (object)
referral_codestring
Example: "cryptofox8"
referred_bystring
Example: "maxDegen"
usernamestring
Example: "username"
Request
const response = await fetch('https://api.prod.paradex.trade/v1/account/profile/referral_code', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "is_username_private": true,
  "programs_eligibility": {
    "affiliate": "Pending",
    "fee": "True",
    "maker": "True",
    "referral": "False"
  },
  "referral_code": "cryptofox8",
  "referred_by": "maxDegen",
  "username": "username"
}

Updates account profile username fields

Respond with requester's account information

POSThttps://api.prod.paradex.trade/v1/account/profile/username
Authorization
Response

OK

Body
is_username_privateboolean
Example: true
programs_eligibilityresponses.ProgramsEligibility (object)
referral_codestring
Example: "cryptofox8"
referred_bystring
Example: "maxDegen"
usernamestring
Example: "username"
Request
const response = await fetch('https://api.prod.paradex.trade/v1/account/profile/username', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "is_username_private": true,
  "programs_eligibility": {
    "affiliate": "Pending",
    "fee": "True",
    "maker": "True",
    "referral": "False"
  },
  "referral_code": "cryptofox8",
  "referred_by": "maxDegen",
  "username": "username"
}

List balances

Respond with requester's own balances

GEThttps://api.prod.paradex.trade/v1/balance
Authorization
Response

OK

Body
resultsarray of responses.BalanceResp (object)

Array of token balances held

Request
const response = await fetch('https://api.prod.paradex.trade/v1/balance', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "results": [
    {
      "last_updated_at": 1681462770114,
      "size": "123003.620",
      "token": "USDC"
    }
  ]
}

List fills

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

GEThttps://api.prod.paradex.trade/v1/fills
Authorization
Query parameters
Response

OK

Body
nextstring

The pointer to fetch next set of records (null if there are no records left)

Example: "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N="
prevstring

The pointer to fetch previous set of records (null if there are no records left)

Example: "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD=="
resultsarray of responses.FillResult (object)

Fill Results List

Request
const response = await fetch('https://api.prod.paradex.trade/v1/fills', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "client_id": "x1234",
      "created_at": 1681375176910,
      "fee": "7.56",
      "fee_currency": "USDC",
      "fill_type": "FILL",
      "id": "8615262148007718462",
      "liquidity": {},
      "market": "BTC-USD-PERP",
      "order_id": "1681462103821101699438490000",
      "price": "30000.12",
      "remaining_size": "0.5",
      "side": {},
      "size": "0.5"
    }
  ]
}

Funding payments history

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.

GEThttps://api.prod.paradex.trade/v1/funding/payments
Authorization
Query parameters
Response

OK

Body
nextstring

The pointer to fetch next set of records (null if there are no records left)

Example: "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N="
prevstring

The pointer to fetch previous set of records (null if there are no records left)

Example: "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD=="
resultsarray of responses.FundingResp (object)

Funding Response data list

Request
const response = await fetch('https://api.prod.paradex.trade/v1/funding/payments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "created_at": 1681375481000,
      "fill_id": "8615262148007718462",
      "id": "1681375578221101699352320000",
      "index": "-2819.53434361",
      "market": "BTC-USD-PERP",
      "payment": "34.4490622"
    }
  ]
}

List open positions

Get all positions owned by current user

GEThttps://api.prod.paradex.trade/v1/positions
Authorization
Response

OK

Body
resultsarray of responses.PositionResp (object)
Request
const response = await fetch('https://api.prod.paradex.trade/v1/positions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
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,
      "liquidation_price": "text",
      "market": "BTC-USD-PERP",
      "realized_pnl": "1234.3",
      "seq_no": 1681471234972000000,
      "side": "SHORT",
      "size": "-0.345",
      "status": "OPEN",
      "unrealized_funding_pnl": "12.234",
      "unrealized_pnl": "-123.23"
    }
  ]
}

List tradebusts

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

GEThttps://api.prod.paradex.trade/v1/tradebusts
Authorization
Query parameters
Response

OK

Body
nextstring

The pointer to fetch next set of records (null if there are no records left)

Example: "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N="
prevstring

The pointer to fetch previous set of records (null if there are no records left)

Example: "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD=="
resultsarray of responses.TradebustResult (object)

List of tradebusts

Request
const response = await fetch('https://api.prod.paradex.trade/v1/tradebusts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "account": 2.073967317963419e+75,
      "busted_fill_id": "12342345",
      "created_at": 1681497002041
    }
  ]
}

List transactions

Retrieves a list of transactions initiated by the user

GEThttps://api.prod.paradex.trade/v1/transactions
Authorization
Query parameters
Response

OK

Body
nextstring

The pointer to fetch next set of records (null if there are no records left)

Example: "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N="
prevstring

The pointer to fetch previous set of records (null if there are no records left)

Example: "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD=="
resultsarray of responses.TransactionResponse (object)

List of transaction responses

Request
const response = await fetch('https://api.prod.paradex.trade/v1/transactions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "next": "eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N=",
  "prev": "eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD==",
  "results": [
    {
      "hash": 1.9324914957482895e+75,
      "id": "12342423",
      "state": "ACCEPTED_ON_L1",
      "type": "TRANSACTION_FILL"
    }
  ]
}

Last updated