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
GET
/contract-symbols
GET
/get_locked_params/<symbol>
GET
/price-range/<symbol>
GET
/open-interest
GET
/notional_cap/<symbol>
GET
/mark-price/<symbol>
GET
/get_funding_info
POST
/position_state/<offset>/<size>
Request Body:
{quote_id: number}
Response Status:
200
or404
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)
Get mark price of symbol on 5000a (Mantle)
Instant trading
Paths
GET
/instant_close/<partyA>
Response Status:
200
Response:
{quote_id: number, quantity_to_close: number, close_price: number}[]
POST /
instant_open
(tbc)POST
/instant_close
(⚠️This endpoint requires an authorization: Bearer {token} header. This can be obtained from the /login endpoint.)Request Body:
{close_price: string, quantity_to_close: string, quote_id: number}
Response Status:
200
or400
Response Body: In case of
400
there will be a message string in body
GET
/nonce/<partyA>
Response Status:
200
Response Body:
{nonce: string}
POST /login
Response Status:
200
or400
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
PartyB Contract Addresses
BASE
0x1EcAbF0Eba136920677C9575FAccee36f30592cf
ARBITRUM
0x00c069d68bc7420740460dbc3cc3fff9b3742421
MANTLE
0x12de0352dd4187af5797f5147c4179f9624346e2
BNB
0xd5a075c88a4188d666fa1e4051913be6782982da
MODE
0x87fc464fa528260f1eeab94fa20f73fed8536eb7
BERA
0x8141c1840F7D190Cd24239C22b1e560e08999B12
Last updated