Search
K
Comment on page

Public Data

Query Contract

  • Path: /api/v1/public/instruments
  • Method: GET
  • Description: Query all contract information
  • Parameters:
└─ symbol: String (Transaction pair)
  • Response:
├─ code: Number
├─ msg: String
└─ data: Array
├─ symbol: String
├─ asset: String
├─ initMarginRate: String (Initial margin rate)
├─ maintainMarginRate: String (Maintenance margin rate)
├─ maxLeverage: String (Maximum lever)
├─ minOrderSize: String (Minimum order quantity)
├─ maxOrderSize: String (Maximum order quantity)
├─ maxPositionSize: String (Maximum Open Interest Statistics)
├─ priceTick: String (Minimum price change)
└─ quantityStep: String (Minimum change quantity)
  • Example:
Request:
https://api.aboard.exchange/arbitrum/api/v1/public/instruments?symbol=ETH-USDC
Response:
{
"code": 0,
"msg": "",
"data": [
{
"symbol": "ETH-USDC",
"asset": "USDC",
"initMarginRate": "",
"maintainMarginRate": "",
"maxLeverage": "",
"minOrderSize": "",
"maxOrderSize": "",
"maxPositionSize": "",
"priceTick": "",
"quantityStep": ""
}
]
}

Index Price/Oracle Price And Funding Rate

  • Path: /api/v1/public/indexOracleFunding
  • Method: GET
  • Description: Query index price, oracle price and funding rate information
  • Parameters:
└─ symbol: String
  • Response:
├─ code: Number
├─ msg: String
└─ data: Array
├─ symbol: String
├─ indexPrice: String
├─ oraclePrice: String
├─ fundingRate: String
└─ time: Number (Update time)
  • Example:
Request:
https://api.aboard.exchange/arbitrum/api/v1/public/indexOracleFunding?symbol=ETH-USDC
Response:
{
"code": 0,
"msg": "",
"data": [
{
"symbol": "ETH-USDC",
"indexPrice": "2004.26",
"oraclePrice": "2005.26",
"fundingRate": "0.00056",
"time": 1597370495002
}
]
}

Query History Funding Rate

  • Path: /api/v1/public/historyFundingRate
  • Method: GET
  • Description: Query history funding rate
  • Parameters:
├─ symbol: String
├─ startTime: Number
├─ endTime: Number
└─ limit: Number (Number of result sets returned, default:100 maximum:500)
  • Response:
├─ code: Number
├─ msg: String
└─ data: Array
├─ symbol: String
├─ fundingRate: String
└─ fundingTime: Number
  • Example:
Request:
https://api.aboard.exchange/arbitrum/api/v1/public/historyFundingRate?symbol=ETH-USDC&startTime=1628575642000&endTime=1628585642000&limit=100
Response:
{
"code": 0,
"msg": "",
"data": [
{
"symbol": "ETH-USDC",
"fundingRate": "-0.03750000",
"fundingTime": 1570608000000
}
]
}

Query History Insurance Fund Balance

  • Path: /api/v1/public/historyInsuranceFund
  • Method: GET
  • Description: Query history insurance fund balance
  • Parameters:
├─ symbol: String
├─ startTime: Number
├─ endTime: Number
└─ limit: Number (Number of result sets returned, default:100 maximum:500)
  • Response:
├─ code: Number
├─ msg: String
└─ data: Array
├─ symbol: String
├─ balance: String
└─ time: Number (Update time)
  • Example:
Request:
https://api.aboard.exchange/arbitrum/api/v1/public/historyInsuranceFund?symbol=ETH-USDC&startTime=1628575642000&endTime=1628585642000&limit=100
Response:
{
"code": 0,
"msg": "",
"data": [
{
"symbol": "ETH-USDC",
"balance": "56204.76",
"time": 1597370495002
}
]
}