Contracts
Retrieve summary of perp contracts traded on Vertex.
Request
GET [ARCHIVE_V2_ENDPOINT]/contracts?edge={true|false}
Request Parameters
edge
bool
No
Wether to retrieve volume and OI metrics for Vertex Edge (i.e: across all chains). When turned off, it only returns metrics for the current chain. Defaults to true.
Response
{
"ETH-PERP_USDC": {
"ticker_id": "ETH-PERP_USDC",
"base_currency": "ETH-PERP",
"quote_currency": "USDC",
"last_price": 1620.3,
"base_volume": 1309.2,
"quote_volume": 2117828.093867611,
"product_type": "perpetual",
"contract_price": 1620.372642114429,
"contract_price_currency": "USD",
"open_interest": 1635.2,
"open_interest_usd": 2649633.3443855145,
"index_price": 1623.293496279935,
"mark_price": 1623.398589416731,
"funding_rate": 0.000068613217104332,
"next_funding_rate_timestamp": 1694379600,
"price_change_percent_24h": -0.6348599635253989
},
"BTC-PERP_USDC": {
"ticker_id": "BTC-PERP_USDC",
"base_currency": "BTC-PERP",
"quote_currency": "USDC",
"last_price": 25744.0,
"base_volume": 794.154,
"quote_volume": 20475749.367766097,
"highest_bid": 25733.0,
"lowest_ask": 25743.0,
"product_type": "perpetual",
"contract_price": 25830.738843799172,
"contract_price_currency": "USD",
"open_interest": 3059.325,
"open_interest_usd": 79024625.11330591,
"index_price": 25878.913320746455,
"mark_price": 25783.996946729356,
"funding_rate": -0.003664562348812546,
"next_funding_rate_timestamp": 1694379600,
"price_change_percent_24h": -0.6348599635253989
}
}Response Fields
ticker_id
string
No
Identifier of a ticker with delimiter to separate base/target.
base_currency
string
No
Symbol of the base asset.
quote_currency
string
No
Symbol of the target asset.
last_price
decimal
No
Last transacted price of base currency based on given quote currency.
base_volume
decimal
No
24-hours trading volume for the pair (unit in base)
quote_volume
decimal
No
24-hours trading volume for the pair (unit in quote/target)
product_type
string
No
Name of product type.
contract_price
string
No
Describes the price per contract.
contract_price_currency
string
No
Describes the currency which the contract is priced in.
open_interest
decimal
No
The current open interest for the perp contract.
open_interest_usd
decimal
No
The value in USD of the current open interest.
index_price
decimal
No
Last calculated index price for underlying of contract
funding_rate
decimal
No
Current 24hr funding rate. Can compute hourly funding rate dividing by 24.
next_funding_rate_timestamp
integer
No
Timestamp of the next funding rate change
price_change_percent_24h
decimal
No
24-hours % price change of market pair
Last updated