Welcome to the new WEEX API documentation. Looking for the previous version?Switch to the legacy docs
WEEX
WEEX Futures REST API
WEEX Futures REST API

Market

Endpoint
Download Schema

Get Server Time

Get Server Time.

GET
/capi/v3/market/time
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Get Server Time › Responses

200

Successful response

serverTime
​integer

Server timeUnix millisecond timestamp

Get Exchange Information

Get Exchange Information.

GET
/capi/v3/market/exchangeInfo
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Get Exchange Information › query Parameters

symbol
​string

Trading pair. Leave empty to return all supported contracts and assets.

contractType
​string

Contract type. Supported values: PERPETUAL, TRADIFI_PERPETUAL.

underlyingType
​string

Underlying asset type.

underlyingSubType
​string

Underlying asset label. Matches if the symbol's underlyingSubType contains this value.

Get Exchange Information › Responses

200

Successful response

​object[]

Collateral assets list. Each item matches the Coin object (assets[]).

​object[]

API access rate limits. Each item matches the Rate-limit object (rateLimits[]).

​object[]

Contract configuration list. Each item matches the Symbol object (symbols[]).

Get Order Book Depth

Get Order Book Depth.

GET
/capi/v3/market/depth
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Get Order Book Depth › query Parameters

symbol
​string · required

Trading pair

limit
​integer

Depth size. Supported values: 15, 200. Default: 15.

Get Order Book Depth › Responses

200

Successful response

​array[]

Bid side depth.Each item is [price, size].

​array[]

Ask side depth.Each item is [price, size].

lastUpdateId
​integer

Last processed order book update ID

Get 24hr Ticker Statistics

Get 24hr Ticker Statistics.

GET
/capi/v3/market/ticker/24hr
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight40

Get 24hr Ticker Statistics › query Parameters

symbol
​string

Trading pair. Leave empty to return all trading pairs.

Get 24hr Ticker Statistics › Responses

200

Successful response

​object[]
symbol
​string

Trading pair

priceChange
​string

Absolute price change over the last 24 hours

priceChangePercent
​string

Percentage price change over the last 24 hours

lastPrice
​string

Last traded price

openPrice
​string

Open price 24 hours ago

highPrice
​string

Highest price in the last 24 hours

lowPrice
​string

Lowest price in the last 24 hours

volume
​string

24-hour trading volume (base asset)

quoteVolume
​string

24-hour trading volume (quote asset)

markPrice
​string

Last mark price

indexPrice
​string

Last index price

openTime
​integer

Timestamp of the first trade in the 24-hour window

closeTime
​integer

Timestamp of the last trade in the 24-hour window

Get Best Bid/Ask

Get Best Bid/Ask.

GET
/capi/v3/market/ticker/bookTicker
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Get Best Bid/Ask › query Parameters

symbol
​string

Trading pair. Leave empty to return all trading pairs.

Get Best Bid/Ask › Responses

200

Successful response

​object[]
symbol
​string

Trading pair

bidPrice
​string

Best bid price

bidQty
​string

Quantity available at the best bid price

askPrice
​string

Best ask price

askQty
​string

Quantity available at the best ask price

time
​integer

Matching engine timestamp

Get Recent Trades

Get Recent Trades.

GET
/capi/v3/market/trades
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight5

Get Recent Trades › query Parameters

symbol
​string · required

Trading pair

limit
​integer

Number of trades to return. Range: 1-1000. Default: 100.

Get Recent Trades › Responses

200

Successful response

​object[]
id
​string

Trade ID

time
​integer

Trade timeUnix millisecond timestamp

price
​string

Trade price

qty
​string

Filled quantity (base asset)

quoteQty
​string

Trade value (quote asset)

isBestMatch
​boolean

Whether the trade was the best match

isBuyerMaker
​boolean

Whether the buyer was the maker

Get Kline Data

Get Kline Data.

GET
/capi/v3/market/klines
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Get Kline Data › query Parameters

symbol
​string · required

Trading pair

interval
​string · required

Kline interval.Allowed values: 1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w.

limit
​integer

Number of klines to return. Range: 1-1000. Default: 100.

Get Kline Data › Responses

200

Successful response

​array[]
array
index[0]
​integer

Open timeUnix millisecond timestamp

Example: 1764505740000
index[1]
​string

Open price

Example: 69340.1
index[2]
​string

High price

Example: 69380.0
index[3]
​string

Low price

Example: 69320.5
index[4]
​string

Close price

Example: 69355.2
index[5]
​string

Volume (base asset)

Example: 25.678
index[6]
​integer

Close timeUnix millisecond timestamp

Example: 1764505800000
index[7]
​string

Quote volume (quote asset)

Example: 1782223.45
index[8]
​integer

Number of trades

Example: 125
index[9]
​string

Taker buy volume (base asset)

Example: 12.345
index[10]
​string

Taker buy volume (quote asset)

Example: 856789.12

Get Index Price Klines

Get Index Price Klines.

GET
/capi/v3/market/indexPriceKlines
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Get Index Price Klines › query Parameters

symbol
​string · required

Trading pair

interval
​string · required

Kline interval.Allowed values: 1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w.

limit
​integer

Number of klines to return. Range: 1-1000. Default: 100.

Get Index Price Klines › Responses

200

Successful response

​array[]
array
index[0]
​integer

Open timeUnix millisecond timestamp

Example: 1764492000000
index[1]
​string

Open price

Example: 69210.5
index[2]
​string

High price

Example: 69400.0
index[3]
​string

Low price

Example: 69180.4
index[4]
​string

Close price

Example: 69320.0
index[5]
​string

Volume (base asset)

Example: 0
index[6]
​integer

Close timeUnix millisecond timestamp

Example: 1764495600000
index[7]
​string

Quote volume (quote asset)

Example: 0
index[8]
​integer

Number of trades

Example: 0
index[9]
​string

Taker buy volume (base asset)

Example: 0
index[10]
​string

Taker buy volume (quote asset)

Example: 0

Get Mark Price Klines

Get Mark Price Klines.

GET
/capi/v3/market/markPriceKlines
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Get Mark Price Klines › query Parameters

symbol
​string · required

Trading pair

interval
​string · required

Kline interval.Allowed values: 1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w.

limit
​integer

Number of klines to return. Range: 1-1000. Default: 100.

Get Mark Price Klines › Responses

200

Successful response

​array[]
array
index[0]
​integer

Open timeUnix millisecond timestamp

Example: 1764504000000
index[1]
​string

Open price

Example: 69310.0
index[2]
​string

High price

Example: 69360.0
index[3]
​string

Low price

Example: 69280.5
index[4]
​string

Close price

Example: 69340.2
index[5]
​string

Volume (base asset)

Example: 15.234
index[6]
​integer

Close timeUnix millisecond timestamp

Example: 1764504900000
index[7]
​string

Quote volume (quote asset)

Example: 1056702.43
index[8]
​integer

Number of trades

Example: 64
index[9]
​string

Taker buy volume (base asset)

Example: 7.100
index[10]
​string

Taker buy volume (quote asset)

Example: 493021.56

Get Historical Klines

Get Historical Klines.

GET
/capi/v3/market/historyKlines
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight5

Get Historical Klines › query Parameters

symbol
​string · required

Trading pair

interval
​string · required

Kline interval.Allowed values: 1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w.

startTime
​integer

Start time (inclusive). Unix millisecond timestamp. Must not be in the future.

endTime
​integer

End time (inclusive). Unix millisecond timestamp. Must not be in the future and must be ≥ startTime.

limit
​integer

Number of klines to return. Range: 1-100. Default: 100.

priceType
​string

Price type. Supported values: LAST (last trade), INDEX (index price), MARK (mark price). Default: LAST.

Get Historical Klines › Responses

200

Successful response

​array[]
array
index[0]
​integer

Open timeUnix millisecond timestamp

Example: 1763894400000
index[1]
​string

Open price

Example: 68000.0
index[2]
​string

High price

Example: 68550.0
index[3]
​string

Low price

Example: 67810.0
index[4]
​string

Close price

Example: 68220.0
index[5]
​string

Volume (base asset)

Example: 320.456
index[6]
​integer

Close timeUnix millisecond timestamp

Example: 1763908800000
index[7]
​string

Quote volume (quote asset)

Example: 21874563.70
index[8]
​integer

Number of trades

Example: 982
index[9]
​string

Taker buy volume (base asset)

Example: 180.120
index[10]
​string

Taker buy volume (quote asset)

Example: 12345678.90

Get Symbol Price

Get Symbol Price.

GET
/capi/v3/market/symbolPrice
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Get Symbol Price › query Parameters

symbol
​string · required

Trading pair

priceType
​string

Price type. Supported values: INDEX, MARK. Default: INDEX.

Get Symbol Price › Responses

200

Successful response

symbol
​string

Trading pair

price
​string

Requested price

time
​integer

System timestampUnix millisecond timestamp

Get Open Interest

Get Open Interest.

GET
/capi/v3/market/openInterest
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight2

Get Open Interest › query Parameters

symbol
​string · required

Trading pair

Get Open Interest › Responses

200

Successful response

symbol
​string

Trading pair

openInterest
​string

Current open interest (contracts)

time
​integer

Matching engine timestampUnix millisecond timestamp

Get Current Funding Rate

Get Current Funding Rate.

GET
/capi/v3/market/premiumIndex
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Get Current Funding Rate › query Parameters

symbol
​string

Trading pair. Leave empty to return all trading pairs.

Get Current Funding Rate › Responses

200

Successful response

​object[]
symbol
​string

Trading pair

markPrice
​string

Latest mark price

indexPrice
​string

Latest index price

lastFundingRate
​string

Most recent funding rate

forecastFundingRate
​string

Forecasted funding rate

interestRate
​string

Underlying benchmark interest rate

nextFundingTime
​integer

Next funding timeUnix millisecond timestamp

time
​integer

Data timestampUnix millisecond timestamp

collectCycle
​integer

Funding interval in minutes

Get Funding Rate History

Get Funding Rate History.

GET
/capi/v3/market/fundingRate
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight5

Get Funding Rate History › query Parameters

symbol
​string · required

Trading pair

startTime
​integer

Start time (inclusive). Unix millisecond timestamp.

endTime
​integer

End time (inclusive). Unix millisecond timestamp. Must be ≥ startTime.

limit
​integer

Number of records. Range: 1-1000. Default: 100.

Get Funding Rate History › Responses

200

Successful response

​object[]
symbol
​string

Trading pair

fundingRate
​string

Historical funding rate

fundingTime
​integer

Funding timeUnix millisecond timestamp

markPrice
​string

Mark price at the funding time

Get API Trading Symbols

Get API Trading Symbols.

GET
/capi/v3/market/apiTradingSymbols
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight5

Get API Trading Symbols › Responses

200

Successful response

​string[]

Notional and Leverage Brackets

Notional and Leverage Brackets.

GET
/capi/v3/market/riskLimits
https://api-contract.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Notional and Leverage Brackets › query Parameters

symbol
​string

Trading pair, e.g. BTCUSDT. Leave empty to return risk limits for all contracts.

Notional and Leverage Brackets › Responses

200

Successful response

​object[]
symbol
​string

Trading pair

​object[]

Notional and leverage bracket list. Each item matches the Bracket object.

Account