Crypto.com Exchange API

https://exchange-docs.crypto.com
Admin
Crypto.com Exchange API v1 provides developers with REST and WebSocket APIs for trading spot,...
Tokens:96,544
Snippets:400
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Response for user.position_balance

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example JSON response received from the user.position_balance channel.

```json
{
  "method": "subscribe",
  "code": 0,
  "result": {
    "subscription": "user.position_balance",
    "channel": "user.position_balance",
    "data": [
      "balances"
      :
      [
        {
          "instrument_name": "BTC",
          "quantity": "-0.0002"
        }
      ],
      "positions"
      :
      [
        {
          "account_id": "11111111-1111-1111-1000-000000000003",
          "instrument_name": "BTCUSD-PERP",
          "type": "PERPETUAL_SWAP",
          "quantity": "-0.2",
          "cost": "-3807.12",
          "open_position_pnl": "-7.11309431848",
          "session_pnl": "0",
          "update_timestamp_ms": 1663927145933,
          "open_pos_cost": "-3800"
        }
      ],
      "isolated_positions"
      :
      [
        {
          "isolation_id": "19848526",
          "leverage": "10",
          "isolation_type": "ISOLATED_MARGIN",
          "balances": [
            {
              "instrument_name": "USD",
              "quantity": "0.55890811999999994"
            }
          ],
          "positions": [ ]
        }
      ]
    ]
  },
  "id": -1
}
```

--------------------------------

### Response Sample for private/staking/get-open-convert

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example JSON response containing a list of open conversion requests.

```json
{
  "id": 1,
  "code": 0,
  "method": "private/staking/get-open-convert",
  "result": {
    "data": [
      {
        "from_instrument_name": "ETH.staked",
        "to_instrument_name": "CDCETH",
        "expected_rate": "1.0203",
        "from_quantity": "3.14159265",
        "slippage_tolerance_bps": "3",
        "actual_rate": "1.0203",
        "to_quantity": "3.14159265",
        "convert_id": 1,
        "status": "COMPLETED",
        "create_timestamp_ms": "1688140984005"
      }
    ]
  }
}
```

--------------------------------

### Request Sample for public/get-tickers

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example URL for querying ticker data for a specific instrument.

```http
https://{URL}/public/get-tickers?instrument_name=BTCUSD-PERP
```

--------------------------------

### Response for user.advance.order.{instrument_name}

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example response containing the current open orders for the subscribed instrument.

```json
{
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD",
    "subscription": "user.advance.order.BTCUSD",
    "channel": "user.advanced.order",
    "data": [{
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848525",
      "client_oid": "1613571154900",
      "order_type": "LIMIT",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "BUY",
      "exec_inst": [],
      "quantity": "0.0100",
      "limit_price": "50000.0",
      "order_value": "500.000000",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD-PERP",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 1,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    },
    {
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848526",
      "client_oid": "1613571154901",
      "order_type": "STOP_LOSS",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "SELL",
      "exec_inst": [],
      "quantity": "0.0100",
      "ref_price": "45000.00",
      "ref_price_type": "MARK_PRICE",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD-PERP",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 2,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    },
    {
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848526",
      "client_oid": "1613571154901",
      "order_type": "TAKE_PROFIT",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "SELL",
      "exec_inst": [],
      "quantity": "0.0100",
      "ref_price": "45000.00",
      "ref_price_type": "MARK_PRICE",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD-PERP",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 3,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    }]
  }
}
```

--------------------------------

### Create Order List Responses

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example responses for successful order creation and partial rejection scenarios.

```json
// Create List of Orders - All ok
{
  "id": 6573,
  "method": "private/create-order-list",
  "code": 0,
  "result": [
    {
      "code": 0,
      "index": 0,
      "client_oid": "api_leg1",
      "order_id": "5755600460443882762"
    },
    {
      "code": 0,
      "index": 1,
      "client_oid": "api_leg2",
      "order_id": "5755600460443882763"
    }
  ]
}
```

```json
// Create List of Orders - Some rejected
{
  "id": xxxxx,
  "method": "private/create-order-list",
  "code": 0,
  "result": [
    {
      "code": 306,
      "index": 0,
      "client_oid": "api_leg_111",
      "message": "INSUFFICIENT_AVAILABLE_BALANCE",
      "order_id": "xxxx"
    },
    {
      "code": 204,
      "index": 1,
      "client_oid": "api_leg_22",
      "message": "DUPLICATE_CLORDID",
      "order_id": "xxxx"
    }
  ]
}
```

--------------------------------

### Response Sample for get-open-stake

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example response containing an array of pending stake and unstake requests.

```json
{
  "id": 1,
  "code": 0,
  "method": "private/staking/get-open-stake",
  "result": {
    "data": [
      {
        "instrument_name": "SOL.staked",
        "underlying_inst_name": "SOL",
        "cycle_id": "1",
        "staking_id": "1",
        "status": "PENDING",
        "account": "12345678-9999-1234-9999-123456789999",
        "quantity": "1",
        "side": "STAKE",
        "create_timestamp_ms": "1668658093600"
      },
      {
        "instrument_name": "SOL.staked",
        "underlying_inst_name": "SOL",
        "cycle_id": "2",
        "staking_id": "2",
        "status": "UNSTAKING",
        "account": "12345678-9999-1234-9999-123456789999",
        "quantity": "0.5",
        "side": "UNSTAKE",
        "create_timestamp_ms": "1668658093600"
      }
    ]
  }
}
```

--------------------------------

### user.positions Response Sample

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example response received from the user.positions channel containing position data.

```json
{
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "subscription": "user.positions",
    "channel": "user.positions",
    "data": [
      {
        "account_id": "52e7c00f-8716-4d6f-afdf-de334bde8ea5",
        "quantity": "0.0500",
        "session_unrealized_pnl": "-14.884000",
        "cost": "2561.516000",
        "open_position_pnl": "-7.302460",
        "open_pos_cost": "2561.328000",
        "session_pnl": "0.000000",
        "pos_initial_margin": "64.684453",
        "pos_maintenance_margin": "44.311397",
        "market_value": "2546.632000",
        "mark_price": "50932.6",
        "target_leverage": "50.00",
        "update_timestamp_ms": 1613578676735,
        "instrument_name": "BTCUSD-PERP",
        "type": "PERPETUAL_SWAP"
      },
      {
        "account_id": "52e7c00f-8716-4d6f-afdf-de334bde8ea5",
        "quantity": "0.03",
        "session_unrealized_pnl": "0",
        "cost": "3.9978",
        "open_position_pnl": "-0.0050705688",
        "open_pos_cost": "3.9226",
        "session_pnl": "-0.0050705688",
        "pos_initial_margin": "0.19989",
        "pos_maintenance_margin": "0.099945",
        "market_value": "3.9978",
        "target_leverage": "10",
        "update_timestamp_ms": 1613578676736,
        "instrument_name": "SOLUSD-PERP",
        "type": "PERPETUAL_SWAP",
        "isolation_id": "19848526",
        "leverage": "10",
        "isolation_type": "ISOLATED_MARGIN",
        "liquidation_price": "125.73",
        "isolated_margin_balance": "0.32003988"
      }
    ]
  }
}
```

--------------------------------

### Request Sample for public/get-valuations

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example URL request to fetch index price data for BTCUSD-INDEX.

```http
https://{URL}/public/get-valuations?instrument_name=BTCUSD-INDEX&valuation_type=index_price&count=1
```

--------------------------------

### Request Sample for private/staking/get-open-convert

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example JSON request body including optional limit and time range parameters.

```json
{
  "id": 1,
  "method": "private/staking/get-open-convert",
  "params": {
    "start_time": 1691455454495,
    "end_time": 1691545277000,
    "limit": "10"
  }
}
```

--------------------------------

### Request and Response for get-order-list-detail

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example JSON request and response for querying order details by list IDs.

```json
{
  "id": 1,
  "method": "private/advanced/get-order-list-detail",
  "params": {
    "list_id_list": [
      "4611686018427705308",
      "4611686018427705309"
    ]
  }
}
```

```json
{
  "id": 1,
  "method": "private/advanced/get-order-list-detail",
  "code": 0,
  "result": {
    "data": [
      {
        "account_id": "5207a638-b79a-4c13-9d41-323be7556c17",
        "order_id": "289987352276367396",
        "client_oid": "289987352276367396",
        "order_type": "LIMIT",
        "time_in_force": "GOOD_TILL_CANCEL",
        "side": "BUY",
        "exec_inst": [],
        "quantity": "0.01000",
        "limit_price": "100000.00",
        "order_value": "1000.0",
        "avg_price": "100000.00",
        "cumulative_quantity": "0.01000",
        "cumulative_value": "1000.0000000",
        "cumulative_fee": "-2.5",
        "status": "FILLED",
        "update_user_id": "5207a638-b79a-4c13-9d41-323be7556c17",
        "order_date": "2025-09-09",
        "instrument_name": "BTC_USD",
        "fee_instrument_name": "USD",
        "list_id": "4611686018427705309",
        "contingency_type": "SPOT_ATTACH",
        "leg_id": 1,
        "attach_order_id": "5755600460443882762",
        "create_time": 1757409908295,
        "create_time_ns": "1757409908295832533",
        "update_time": 1757430498603
      },
      {
        "account_id": "5207a638-b79a-4c13-9d41-323be7556c17",
        "order_id": "289987352276367397",
        "client_oid": "289987352276367397",
        "order_type": "STOP_LOSS",
        "time_in_force": "GOOD_TILL_CANCEL",
        "side": "SELL",
        "exec_inst": [],
        "quantity": "0.01000",
        "limit_price": "0.00",
        "order_value": "900.0",
        "avg_price": "0.00",
        "cumulative_quantity": "0.00000",
        "cumulative_value": "0.0000000",
        "cumulative_fee": "0",
        "status": "PENDING",
        "update_user_id": "5207a638-b79a-4c13-9d41-323be7556c17",
        "order_date": "2025-09-09",
        "instrument_name": "BTC_USD",
        "fee_instrument_name": "USD",
        "list_id": "4611686018427705309",
        "contingency_type": "SPOT_ATTACH",
        "leg_id": 2,
        "attach_order_id": "5755600460443882762",
        "ref_price": "90000.00",
        "ref_price_type": "MARK_PRICE",
        "create_time": 1757409908295,
        "create_time_ns": "1757409908295832533",
        "update_time": 1757409908295
      }
    ]
  }
}
```

--------------------------------

### Create OTOCO Request and Response

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example JSON request to create an OTOCO strategy and the corresponding successful response.

```json
{
  "method":"private/advanced/create-otoco",
  "id":123456789,
  "nonce":123456789000,
  "params":{
    "order_list":[
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"LIMIT",
        "price":"93000",
        "side":"BUY"
      },
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"STOP_LOSS",
        "ref_price":"80000",
        "side":"SELL"
      },
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"TAKE_PROFIT",
        "ref_price":"108000",
        "side":"SELL"
      }
    ]
  }
}
```

```json
{
  "id" : 1661331443,
  "method" : "private/advanced/create-otoco",
  "code" : 0,
  "result" : {
    "list_id" : 6498090546073120100
  }
}
```

--------------------------------

### Get Account Settings Request and Response

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Retrieves current STP account settings and leverage configuration.

```json
{
  "id": 697,
  "method": "private/get-account-settings",
  "api_key": "00000009-1111-1111-1111-000000000000",
  "params": {},
  "nonce": 1721989202781
}
```

```json
{
  "id": 697,
  "method": "private/get-account-settings",
  "code": 0,
  "result": [
    {
      "leverage": 20,
      "stp_id": 100,
      "stp_scope": "S",
      "stp_inst": "M"
    }
  ]
}
```

--------------------------------

### Create Order Request and Response

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example JSON payloads for the private/create-order request and its corresponding asynchronous confirmation response.

```json
{
  "id": 1,
  "nonce" : 1610905028000,
  "method": "private/create-order",
  "params": {
    "instrument_name": "BTCUSD-PERP",
    "side": "SELL",
    "type": "LIMIT",
    "price": "50000.5",
    "quantity": "1",
    "client_oid": "c5f682ed-7108-4f1c-b755-972fcdca0f02",
    "exec_inst": ["POST_ONLY"],
    "time_in_force": "FILL_OR_KILL"
  }
}
```

```json
{
  "id": 1,
  "method": "private/create-order",
  "code": 0,
  "result": {
    "client_oid": "c5f682ed-7108-4f1c-b755-972fcdca0f02",
    "order_id": "18342311"
  }
}
```

--------------------------------

### Ticker Response Sample

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example response received from the ticker subscription channel containing market data.

```json
{
  "id": -1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "ticker.BTCUSD-PERP",
    "channel": "ticker",
    "data": [{
      "h": "51790.00",        // Price of the 24h highest trade
      "l": "47895.50",        // Price of the 24h lowest trade, null if there weren't any trades
      "a": "51174.500000",    // The price of the latest trade, null if there weren't any trades
      "c": "0.03955106",      // 24-hour price change, null if there weren't any trades
      "b": "51170.000000",    // The current best bid price, null if there aren't any bids
      "bs": "0.1000",         // The current best bid size, null if there aren't any bids
      "k": "51180.000000",    // The current best ask price, null if there aren't any asks
      "ks": "0.2000",         // The current best ask size, null if there aren't any bids
      "i": "BTCUSD-PERP",     // Instrument name
      "v": "879.5024",        // The total 24h traded volume
      "vv": "26370000.12",    // The total 24h traded volume value (in USD)
      "oi": "12345.12",       // Open interest
      "t": 1613580710768
    }]
  }
}
```

--------------------------------

### user.account_risk Response

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example response payload containing account balances, positions, and margin details.

```json
{
  "method": "subscribe",
  "code": 0,
  "result": {
    "account_id": "11111111-1111-1111-1000-000000000003",
    "subscription": "user.account_risk",
    "channel": "user.account_risk",
    "data": [
      {
        "instrument_name": "USD",
        "total_available_balance": "10009769008.34209823",
        "total_cash_balance": "10010020146.28690719",
        "total_initial_margin": "62.47231001",
        "total_maintenance_margin": "30.29753001",
        "total_position_cost": "1907.12000000",
        "total_session_unrealized_pnl": "2.61999999999989088",
        "total_margin_balance": "10009769070.81440734",
        "total_session_realized_pnl": "0",
        "total_effective_leverage": "0.00000019",
        "position_limit": "3000000.00000000",
        "used_position_limit": "4025.50000000",
        "is_liquidating": false,
        "total_borrow": "0.00000000",
        "margin_score": "0.00000000",
        "balances": [
          {
            "instrument_name": "USD",
            "quantity": "9999999992.88690568152",
            "market_value": "9999999992.88690567",
            "collateral_eligible": "true",
            "haircut": "0.8800000",
            "collateral_amount": "9999999992.00690567",
            "max_withdrawal_balance": "9999999992.88690567",
            "reserved_qty": "0"
          },
          {
            "instrument_name": "USDT",
            "quantity": "10000000",
            "market_value": "9999801.00000000",
            "collateral_eligible": "true",
            "haircut": "1.00000",
            "collateral_amount": "9999800.000000000",
            "max_withdrawal_balance": "10000000.00000000",
            "reserved_qty": "0"
          }
        ],
        "positions": [
          {
            "account_id": "11111111-1111-1111-1000-000000000003",
            "quantity": "-0.1",
            "market_value": "-1904.50000000",
            "session_unrealized_pnl": "2.61999999",
            "open_position_pnl": "-7.11309431848",
            "session_pnl": "0",
            "cost": "-1907.12",
            "open_pos_cost": "-1900",
            "liquidation_price": "0.0",
            "pos_initial_margin": "29.21503000",
            "pos_maintenance_margin": "21.59703000",
            "mark_price": "19045.0",
            "effective_leverage": "0.000000",
            "target_leverage": "100.000000",
            "update_timestamp_ms": 1663927002224,
            "instrument_name": "BTCUSD-PERP",
            "type": "PERPETUAL_SWAP"
          }
        ],
        "total_collateral_value": "10009769068.19440460",
        "total_isolated_cash_balance": "0.55890812",
        "isolated_positions": [
          {
            "isolation_id": "19848526",
            "leverage": "10",
            "isolation_type": "ISOLATED_MARGIN",
            "instrument_name": "USD",
            "total_available_balance": "0",
            "total_cash_balance": "0.55890812",
            "total_initial_margin": "0.52978",
            "total_maintenance_margin": "0.132445",
            "total_position_cost": "3.9978",
            "total_session_unrealized_pnl": "0",
            "total_margin_balance": "0.52978",
            "total_session_realized_pnl": "-0.0050705688",
            "total_effective_leverage": "7.54615123",
            "position_limit": "5.2978",
            "used_position_limit": "3.9978",
            "is_liquidating": false,
            "total_borrow": "0.00000000",
            "margin_score": "0.00000000",
            "balances": [
              {
                "instrument_name": "USD",
                "quantity": "0.55890812",
                "market_value": "0.55890812",
                "collateral_eligible": "true",
                "haircut": "0",
                "collateral_amount": "0.55890812",
                "max_withdrawal_balance": "0",
                "reserved_qty": "0"
              }
            ],
            "positions": [
              {
                "account_id": "11111111-1111-1111-1000-000000000003",
                "isolation_id": "19848526",
                "leverage": "10",
                "isolation_type": "ISOLATED_MARGIN",
                "quantity": "0.03",
                "market_value": "3.9978",
                "session_unrealized_pnl": "0",
                "open_position_pnl": "-0.0050705688",
                "session_pnl": "-0.0050705688",
                "cost": "3.9978",
                "open_pos_cost": "3.9226",
                "liquidation_price": "119.67",
                "pos_initial_margin": "0.26489",
                "pos_maintenance_margin": "0.132445",
                "mark_price": "133.26",
                "effective_leverage": "0",
                "target_leverage": "10",
                "update_timestamp_ms": 1663927002224,
                "instrument_name": "SOLUSD-PERP"
              }
            ]
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Get Expired Settlement Price

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Retrieves the settlement price for expired instruments via a GET request.

```http
https://{URL}/public/get-expired-settlement-price?instrument_type=FUTURE&page=1
```

```json
{
  "id": -1,
  "method": "public/get-expired-settlement-price",
  "code": 0,
  "result": {
    "data": [{
      "i": "BTCUSD-210528m2",
      "x": 1622145600000,
      "v": "50776.73000",
      "t": 1622145540000
    },
      {
        "i": "BTCUSD-210528m3",
        "x": 1622160000000,
        "v": "38545.570000",
        "t": 1622159940000
      }]
  }
}
```

--------------------------------

### GET public/get-expired-settlement-price

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Fetches the settlement price of expired instruments.

```APIDOC
## GET public/get-expired-settlement-price

### Description
Fetches settlement price of expired instruments.

### Method
GET

### Endpoint
/public/get-expired-settlement-price

### Parameters
#### Query Parameters
- **instrument_type** (string) - Required - FUTURE
- **page** (number) - Optional - Default is 1

### Response
#### Success Response (200)
- **i** (string) - Instrument name
- **x** (long) - Expiry timestamp (millisecond)
- **v** (string) - Value
- **t** (long) - Timestamp

### Response Example
{
  "id": -1,
  "method": "public/get-expired-settlement-price",
  "code": 0,
  "result": {
    "data": [{
      "i": "BTCUSD-210528m2",
      "x": 1622145600000,
      "v": "50776.73000",
      "t": 1622145540000
    }]
  }
}
```

--------------------------------

### GET public/get-tickers

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Fetches the public tickers for all or a particular instrument.

```APIDOC
## GET public/get-tickers

### Description
Fetches the public tickers for all or a particular instrument.

### Method
GET

### Endpoint
/public/get-tickers

### Parameters
#### Query Parameters
- **instrument_name** (string) - Optional - e.g. BTCUSD-PERP

### Response
#### Success Response (200)
- **h** (string) - Price of the 24h highest trade
- **l** (string) - Price of the 24h lowest trade, null if there weren't any trades
- **a** (string) - The price of the latest trade, null if there weren't any trades
- **i** (string) - Instrument name
- **v** (string) - The total 24h traded volume
- **vv** (string) - The total 24h traded volume value (in USD)
- **oi** (string) - The open interest
- **c** (string) - 24-hour price change, null if there weren't any trades
- **b** (string) - The current best bid price, null if there aren't any bids
- **k** (string) - The current best ask price, null if there aren't any asks
- **t** (number) - The published timestamp in ms

#### Response Example
{
  "id": -1,
  "method": "public/get-tickers",
  "code": 0,
  "result": {
    "data": [{
      "h": "51790.00",
      "l": "47895.50",
      "a": "51174.500000",
      "i": "BTCUSD-PERP",
      "v": "879.5024",
      "vv": "26370000.12",
      "oi": "12345.12",
      "c": "0.03955106",
      "b": "51170.000000",
      "k": "51180.000000",
      "t": 1613580710768
    }]
  }
}
```

--------------------------------

### GET public/get-trades

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Fetches the public trades for a particular instrument.

```APIDOC
## GET public/get-trades

### Description
Fetches the public trades for a particular instrument.

### Method
GET

### Endpoint
/public/get-trades

### Parameters
#### Query Parameters
- **instrument_name** (string) - Required - e.g. BTCUSD-PERP
- **count** (number) - Optional - The maximum number of trades to be retrieved. Default: 25, Max: 150
- **start_ts** (number or string) - Optional - Start time in Unix time format (inclusive). Default: end_time - 1 day.
- **end_ts** (number or string) - Optional - End time in Unix time format (exclusive). Default: current system timestamp.

### Response
#### Success Response (200)
- **d** (string of number) - Trade ID
- **t** (number) - Trade timestamp in milliseconds
- **tn** (string of number) - Trade timestamp in nanoseconds
- **q** (number) - Trade quantity
- **p** (number) - Trade price
- **s** (string) - Side (BUY or SELL)
- **i** (string) - Instrument name
- **m** (string of number) - Trade match ID

### Response Example
{
  "id": 1,
  "method": "public/get-trades",
  "code": 0,
  "result": {
    "data": [{
      "d": "15281981878",
      "t": 1613547060925,
      "tn": "1613547060925523623",
      "q": "0.181900",
      "p": "50772.000000",
      "s": "SELL",
      "i": "BTCUSD-PERP",
      "m": "76423"
    }]
  }
}
```

--------------------------------

### POST private/get-fee-rate

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Get fee rates for user’s account.

```APIDOC
## POST private/get-fee-rate

### Description
Get fee rates for user’s account.

### Method
POST

### Endpoint
private/get-fee-rate

### Response
#### Success Response (200)
- **spot_tier** (string) - 30day spot trading volume tier
- **deriv_tier** (string) - 30day deriv trading volume tier
- **effective_spot_maker_rate_bps** (string) - 30day spot maker rate in bps
- **effective_spot_taker_rate_bps** (string) - 30day spot taker rate in bps
- **effective_deriv_maker_rate_bps** (string) - 30day deriv maker rate in bps
- **effective_deriv_taker_rate_bps** (string) - 30day deriv taker rate in bps

#### Response Example
{
  "id": 1,
  "method": "/private/get-fee-rate",
  "code": 0,
  "result": {
    "spot_tier": "3",
    "deriv_tier": "3",
    "effective_spot_maker_rate_bps": "6.5",
    "effective_spot_taker_rate_bps": "6.9",
    "effective_deriv_maker_rate_bps": "1.1",
    "effective_deriv_taker_rate_bps": "3"
  }
}
```

--------------------------------

### Response Samples for Fiat Deposit Info

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example responses showing bank details for different payment networks like usd_cubix and usd_swift.

```json
--usd_cubix
{
    "id": "123456",
    "code": 0,
    "result": {
        "deposit_info_list": [
            {
                "payment_network": "usd_cubix",
                "currency": "USD",
                "bank_details": {
                    "account_holder_name": null,
                    "bank_name": null,
                    "bank_address": null,
                    "bank_country": null,
                    "routing_number": null,
                    "account_number": null,
                    "recipient_name": null,
                    "recipient_address": null,
                    "bic_code": null,
                    "iban_code": null,
                    "reference_code": null,
                    "sort_code": null,
                    "cubix_partner_name": "Crypto.com",
                    "cubix_account_name": "Foris Dax Inc",
                    "cubix_account_id": "48e8431d-2026-41d4-a872-b1ed00db8626",
                    "cubix_account_number": "5859",
                    "account_type": null,
                    "meta": null
                }
            }
        ]
    }
}

--usd_swift
{
      "id": 0,
      "code": 0,
      "result": {
          "deposit_info_list": [
              {
                  "payment_network": "usd_swift",
                  "currency": "USD",
                  "bank_details": {
                      "account_holder_name": null,
                      "bank_name": "Customers Bank",
                      "bank_address": "701 Reading Avenue, West Reading, Pennsylvania 19611",
                      "bank_country": null,
                      "routing_number": "031302971",
                      "account_number": "5415859",
                      "recipient_name": "FORIS DAX LIMITED",
                      "recipient_address": "P.O. BOX 31910, 20 GENESIS CLOSE GRAND CAYMAN",
                      "bic_code": "CUESUS33",
                      "iban_code": null,
                      "reference_code": "676938157158298",
                      "sort_code": null,
                      "cubix_partner_name": null,
                      "cubix_account_name": null,
                      "cubix_account_id": null,
                      "cubix_account_number": null,
                      "meta": null
                  }
              }
          ]
      }
  }
```

--------------------------------

### GET public/get-insurance

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Fetches the balance of the Insurance Fund for a particular currency.

```APIDOC
## GET public/get-insurance

### Description
Fetches balance of Insurance Fund for a particular currency.

### Method
GET

### Endpoint
/public/get-insurance

### Parameters
#### Query Parameters
- **instrument_name** (string) - Required - e.g. USD
- **count** (number) - Optional - Default is 25
- **start_ts** (number) - Optional - Default timestamp is 1 day ago (Unix timestamp)
- **end_ts** (number) - Optional - Default timestamp is current time (Unix timestamp)

### Response
#### Success Response (200)
- **instrument_name** (string) - e.g. USD
- **data** (array) - List of insurance fund records

### Response Example
{
  "id": 1,
  "method": "public/get-insurance",
  "code": 0,
  "result": {
    "data": [{
      "v": "50000000",
      "t": 1613539503965
    }],
    "instrument_name": "USD"
  }
}
```

--------------------------------

### GET public/get-valuations

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Fetches specific valuation type data for a given instrument.

```APIDOC
## GET public/get-valuations

### Description
Fetches certain valuation type data for a particular instrument.

### Method
GET

### Endpoint
/public/get-valuations

### Parameters
#### Query Parameters
- **instrument_name** (string) - Required - e.g. BTCUSD-INDEX
- **valuation_type** (string) - Required - List of available types: index_price, mark_price, funding_hist, funding_rate, estimated_funding_rate
- **count** (number) - Optional - Default is 25
- **start_ts** (number) - Optional - Default timestamp is 30 days ago for funding_hist, and 1 day ago for other valuation_type (Unix timestamp)
- **end_ts** (number) - Optional - Default timestamp is current time (Unix timestamp)

### Request Example
https://{URL}/public/get-valuations?instrument_name=BTCUSD-INDEX&valuation_type=index_price&count=1

### Response
#### Success Response (200)
- **instrument_name** (string) - e.g. BTCUSD-INDEX
- **data** (array) - List of valuation data points containing 'v' (value) and 't' (timestamp)

#### Response Example
{
  "id": 1,
  "method": "public/get-valuations",
  "code": 0,
  "result": {
    "data": [{
      "v": "50776.73000",
      "t": 1613547318000
    }],
    "instrument_name": "BTCUSD-INDEX"
  }
}
```

--------------------------------

### GET public/get-book

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Fetches the public order book for a particular instrument and depth.

```APIDOC
## GET public/get-book

### Description
Fetches the public order book for a particular instrument and depth.

### Method
GET

### Endpoint
/public/get-book

### Parameters
#### Query Parameters
- **instrument_name** (string) - Required - e.g. BTCUSD-PERP
- **depth** (string) - Required - Number of bids and asks to return (up to 50)

### Request Example
https://{URL}/public/get-book?instrument_name=BTCUSD-PERP&depth=10

### Response
#### Success Response (200)
- **instrument_name** (string) - e.g. BTCUSD-PERP
- **depth** (string) - Number of bids and asks to return (up to 50)
- **data** (array) - Contains bids and asks arrays

#### Response Example
{
  "code": 0,
  "method": "public/get-book",
  "result": {
    "depth": 10,
    "data": [{
      "asks": [
        ["50126.000000", "0.400000", "0"]
      ],
      "bids": [
        ["50113.500000", "0.400000", "0"]
      ]
    }],
    "instrument_name": "BTCUSD-PERP"
  }
}
```

--------------------------------

### Candlestick Subscription Response

Source: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html

Example response received after a successful candlestick subscription.

```json
{
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "candlestick.1D.BTCUSD-PERP",
    "channel": "candlestick",
    "interval": "1D",
    "data": [{
      "o": "51140.500000",    // Open price
      "h": "51699.000000",    // High price
      "l": "49212.000000",    // Low price
      "c": "51313.500000",    // Close price
      "v": "867.9432",        // Volume
      "t": 1612224000000      // Start time
    }]
  }
}
```
Tokens:
Raw