Perps Hub

Perps Hub API URLs

Format

https://www.domainPerEnv/v1/{symmDeploymentId}/{multiaccount}

⚠️Multiaccounts must be valid checksummed addresses

{
  "BSC (56a)": {
    "prod": "https://www.perps-streaming.com/v1/56a/{multiaccount}",
  },
  "ARBITRUM (42161a)": {
    "prod": "https://www.perps-streaming.com/v1/42161a/{multiaccount}",
  },
  "MANTLE (5000a)": {
    "prod": "https://www.perps-streaming.com/v1/5000a/{multiaccount}",
  },
  "MODE (34443a)": {
    "prod": "https://www.perps-streaming.com/v1/34443a/{multiaccount}",
  }
}

Perps Hub Endpoints:

Streaming

Paths

1. GET /contract-symbols

2. GET /get_locked_params/<symbol>

3. GET /price-range/<symbol>

4. GET /open-interest

5. GET /notional_cap/<symbol>

6. GET /mark-price/<symbol>

7. GET /get_funding_info

8. POST /position_state/<offset>/<size>

   1. Request Body: {quote_id: number}

   2. Response Status: 200 or 404

   3. Response Body (200): { count: number; position_state: { id: string; quote_id: number; filled_amount_open: number; filled_amount_close: number; action_status: 'failed' | 'success'; last_seen_action: string; failure_type: string; order_type: number; create_time: number; modify_time: number; counterparty_address: string; error_code: string; state_type: string; }[]; };

Examples

Get locked params on 56a (BSC)	https://www.perps-streaming.com/v1/56a/0x650a2D6C263A93cFF5EdD41f836ce832F05A1cF3/get_locked_params/BTCUSDT
Get mark price of symbol on 5000a (Mantle)	https://www.perps-streaming.com/v1/5000a/0xecbd0788bb5a72f9dfdac1ffeaaf9b7c2b26e456/mark-price/ETHUSDT

Instant trading

Paths

1. GET /instant_close/<partyA>

   1. Response Status: 200

   2. Response: {quote_id: number, quantity_to_close: number, close_price: number}[]

2. POST /instant_open (tbc)

3. POST /instant_close (⚠️This endpoint requires an authorization: Bearer {token} header. This can be obtained from the /login endpoint.)

   1. Request Body: {close_price: string, quantity_to_close: string, quote_id: number}

   2. Response Status: 200 or 400

   3. Response Body: In case of 400 there will be a message string in body

4. GET /nonce/<partyA>

   1. Response Status: 200

   2. Response Body: {nonce: string}

5. POST /login

   1. Response Status: 200 or 400

   2. Response Body: In case of 400 there will be a message string in body giving further details

Examples

Get instant close status of a quote on Mantle

https://www.perps-streaming.com/v1/5000a/0xecbd0788bb5a72f9dfdac1ffeaaf9b7c2b26e456/instant_close/0xBd047C4F108282745E0c4DFE2f97fFaF2e67032b