` for the bucket backing that market.
**Binance**
```python
c = await sdk.collateral('binance:spot:BTCUSDT')
```
```
Collateral(equity=Decimal('10240.55'), free_collateral=Decimal('8120.00'))
```
**Bit2Me**
```python
c = await sdk.collateral('bit2me:spot:BTC/EUR')
```
```
Collateral(equity=Decimal('10240.55'), free_collateral=Decimal('8120.00'))
```
**Bitget**
```python
c = await sdk.collateral('bitget:spot:BTCUSDT')
```
```
Collateral(equity=Decimal('10240.55'), free_collateral=Decimal('8120.00'))
```
**Bybit**
```python
c = await sdk.collateral('bybit:spot:BTCUSDT')
```
```
Collateral(equity=Decimal('10240.55'), free_collateral=Decimal('8120.00'))
```
**Coinbase**
```python
c = await sdk.collateral('coinbase:spot:BTC-USD')
```
```
Collateral(equity=Decimal('10240.55'), free_collateral=Decimal('8120.00'))
```
**dYdX**
```python
c = await sdk.collateral('dydx:perp:BTC-USD')
```
```
Collateral(equity=Decimal('10240.55'), free_collateral=Decimal('8120.00'))
```
**Hyperliquid**
```python
c = await sdk.collateral('hyperliquid:spot:UBTC/USDC:142')
```
```
Collateral(equity=Decimal('9875.20'), free_collateral=Decimal('7640.00'))
```
**Kraken**
```python
c = await sdk.collateral('kraken:spot:XBTUSD')
```
```
Collateral(equity=Decimal('10240.55'), free_collateral=Decimal('8120.00'))
```
**MEXC**
```python
c = await sdk.collateral('mexc:spot:BTCUSDT')
```
```
Collateral(equity=Decimal('10240.55'), free_collateral=Decimal('8120.00'))
```
#### `available_notional`
```python
available_notional(market_id, /) -> Decimal
```
Fetch the maximum notional position you could open right now.
Spot: the free quote-token balance. Perps: available collateral times the market's
maximum leverage. This is opening capacity, deliberately separate from `collateral()`,
which is about liquidation distance.
**Binance**
```python
notional = await sdk.available_notional('binance:spot:BTCUSDT')
```
```
Decimal('8120.00')
```
**Bit2Me**
```python
notional = await sdk.available_notional('bit2me:spot:BTC/EUR')
```
```
Decimal('8120.00')
```
**Bitget**
```python
notional = await sdk.available_notional('bitget:spot:BTCUSDT')
```
```
Decimal('8120.00')
```
**Bybit**
```python
notional = await sdk.available_notional('bybit:spot:BTCUSDT')
```
```
Decimal('8120.00')
```
**Coinbase**
```python
notional = await sdk.available_notional('coinbase:spot:BTC-USD')
```
```
Decimal('8120.00')
```
**dYdX**
```python
notional = await sdk.available_notional('dydx:perp:BTC-USD')
```
```
Decimal('8120.00')
```
**Hyperliquid**
```python
notional = await sdk.available_notional('hyperliquid:spot:UBTC/USDC:142')
```
```
Decimal('7640.00')
```
**Kraken**
```python
notional = await sdk.available_notional('kraken:spot:XBTUSD')
```
```
Decimal('8120.00')
```
**MEXC**
```python
notional = await sdk.available_notional('mexc:spot:BTCUSDT')
```
```
Decimal('8120.00')
```
### Trading
#### `place_order`
```python
place_order(market_id, /, order, *, settings={}) -> OrderResponse
```
Place an order in the market.
`LIMIT` rests at `price` unless `settings` request another time-in-force.
`POST_ONLY` is maker-only: the venue rejects or cancels rather than taking liquidity.
`MARKET` executes immediately with `price` as the worst acceptable limit; venues
without native market orders send an aggressive non-resting (IOC) limit, and fills may
be partial. A venue that can't honor the requested semantics raises rather than
placing a materially different order.
**Args**
- `order`: `qty` in signed base units (positive buys, negative sells), `price`, and
`type`.
- `settings`: Venue-specific options keyed by venue name, e.g. `{'dydx': {...}}`; see
each venue page for accepted keys.
**Bit2Me**
```python
order = {'type': 'LIMIT', 'qty': 0.01, 'price': 60_000}
response = await sdk.place_order('bit2me:spot:BTC/EUR', order)
```
```
OrderResponse(id='00000000-0000-4000-8000-000000000001', details={...})
```
**Bybit**
```python
order = {'type': 'LIMIT', 'qty': 0.01, 'price': 60_000}
response = await sdk.place_order('bybit:spot:BTCUSDT', order)
```
```
OrderResponse(id='00000000-0000-4000-8000-000000000001', details={...})
```
**Coinbase**
```python
order = {'type': 'LIMIT', 'qty': 0.01, 'price': 60_000}
response = await sdk.place_order('coinbase:spot:BTC-USD', order)
```
```
OrderResponse(id='00000000-0000-4000-8000-000000000001', details={...})
```
**dYdX**
```python
order = {'type': 'LIMIT', 'qty': 0.01, 'price': 60_000}
response = await sdk.place_order('dydx:perp:BTC-USD', order)
```
```
OrderResponse(id='Ci0KK2R5ZHgxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXE2NndtODIVAQAAABhA', details={...})
```
**Hyperliquid**
```python
order = {'type': 'LIMIT', 'qty': 0.01, 'price': 60_000}
response = await sdk.place_order('hyperliquid:spot:UBTC/USDC:142', order)
```
```
OrderResponse(id='184920371', details={...})
```
**MEXC**
```python
order = {'type': 'LIMIT', 'qty': 0.01, 'price': 60_000}
response = await sdk.place_order('mexc:spot:BTCUSDT', order)
```
```
OrderResponse(id='4834937', details={...})
```
#### `place_orders`
```python
place_orders(market_id, /, orders, *, settings={}) -> Sequence[OrderResponse]
```
Place several orders concurrently: one response per order, in input order.
**Args**
- `orders`: The orders to place, each as for `place_order`.
- `settings`: Venue-specific options, applied to every order.
**Bit2Me**
```python
orders = [
{'type': 'LIMIT', 'qty': 0.01, 'price': 60_000},
{'type': 'LIMIT', 'qty': 0.01, 'price': 59_500},
]
responses = await sdk.place_orders('bit2me:spot:BTC/EUR', orders)
```
```
[OrderResponse(id='00000000-0000-4000-8000-000000000001', details={...}), OrderResponse(id='00000000-0000-4000-8000-000000000002', details={...})]
```
**Bybit**
```python
orders = [
{'type': 'LIMIT', 'qty': 0.01, 'price': 60_000},
{'type': 'LIMIT', 'qty': 0.01, 'price': 59_500},
]
responses = await sdk.place_orders('bybit:spot:BTCUSDT', orders)
```
```
[OrderResponse(id='00000000-0000-4000-8000-000000000001', details={...}), OrderResponse(id='00000000-0000-4000-8000-000000000002', details={...})]
```
**Coinbase**
```python
orders = [
{'type': 'LIMIT', 'qty': 0.01, 'price': 60_000},
{'type': 'LIMIT', 'qty': 0.01, 'price': 59_500},
]
responses = await sdk.place_orders('coinbase:spot:BTC-USD', orders)
```
```
[OrderResponse(id='00000000-0000-4000-8000-000000000001', details={...}), OrderResponse(id='00000000-0000-4000-8000-000000000002', details={...})]
```
**dYdX**
```python
orders = [
{'type': 'LIMIT', 'qty': 0.01, 'price': 60_000},
{'type': 'LIMIT', 'qty': 0.01, 'price': 59_500},
]
responses = await sdk.place_orders('dydx:perp:BTC-USD', orders)
```
```
[OrderResponse(id='Ci0KK2R5ZHgxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXE2NndtODIVAQAAABhA', details={...}), OrderResponse(id='Ci0KK2R5ZHgxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXE2NndtODIVAgAAABhA', details={...})]
```
**Hyperliquid**
```python
orders = [
{'type': 'LIMIT', 'qty': 0.01, 'price': 60_000},
{'type': 'LIMIT', 'qty': 0.01, 'price': 59_500},
]
responses = await sdk.place_orders('hyperliquid:spot:UBTC/USDC:142', orders)
```
```
[OrderResponse(id='184920371', details={...}), OrderResponse(id='184920372', details={...})]
```
#### `cancel_order`
```python
cancel_order(market_id, /, id, *, settings={}) -> Any
```
Cancel an order in the market.
**Args**
- `id`: The order ID, as returned by `place_order`.
- `settings`: Venue-specific options keyed by venue name.
**Bit2Me**
```python
await sdk.cancel_order('bit2me:spot:BTC/EUR', '00000000-0000-4000-8000-000000000001')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**Bybit**
```python
await sdk.cancel_order('bybit:spot:BTCUSDT', '00000000-0000-4000-8000-000000000001')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**Coinbase**
```python
await sdk.cancel_order('coinbase:spot:BTC-USD', '00000000-0000-4000-8000-000000000001')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**dYdX**
```python
await sdk.cancel_order('dydx:perp:BTC-USD', 'Ci0KK2R5ZHgxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXE2NndtODIVAQAAABhA')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**Hyperliquid**
```python
await sdk.cancel_order('hyperliquid:spot:UBTC/USDC:142', '184920371')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**MEXC**
```python
await sdk.cancel_order('mexc:spot:BTCUSDT', '4834937')
print('Cancellation request completed')
```
```
Cancellation request completed
```
#### `cancel_orders`
```python
cancel_orders(market_id, /, ids, *, settings={}) -> Any
```
Cancel several orders concurrently.
**Args**
- `ids`: The order IDs to cancel.
- `settings`: Venue-specific options, applied to every cancel.
**Bit2Me**
```python
await sdk.cancel_orders('bit2me:spot:BTC/EUR', ['00000000-0000-4000-8000-000000000001', '00000000-0000-4000-8000-000000000002'])
print('Cancellation request completed')
```
```
Cancellation request completed
```
**Bybit**
```python
await sdk.cancel_orders('bybit:spot:BTCUSDT', ['00000000-0000-4000-8000-000000000001', '00000000-0000-4000-8000-000000000002'])
print('Cancellation request completed')
```
```
Cancellation request completed
```
**Coinbase**
```python
await sdk.cancel_orders('coinbase:spot:BTC-USD', ['00000000-0000-4000-8000-000000000001', '00000000-0000-4000-8000-000000000002'])
print('Cancellation request completed')
```
```
Cancellation request completed
```
**dYdX**
```python
await sdk.cancel_orders('dydx:perp:BTC-USD', ['Ci0KK2R5ZHgxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXE2NndtODIVAQAAABhA', 'Ci0KK2R5ZHgxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXE2NndtODIVAgAAABhA'])
print('Cancellation request completed')
```
```
Cancellation request completed
```
**Hyperliquid**
```python
await sdk.cancel_orders('hyperliquid:spot:UBTC/USDC:142', ['184920371', '184920372'])
print('Cancellation request completed')
```
```
Cancellation request completed
```
**MEXC**
```python
await sdk.cancel_orders('mexc:spot:BTCUSDT', ['4834937', '4834938'])
print('Cancellation request completed')
```
```
Cancellation request completed
```
#### `cancel_open_orders`
```python
cancel_open_orders(market_id, /, *, settings={}) -> Any
```
Cancel everything `open_orders()` returns.
**Args**
- `settings`: Venue-specific options keyed by venue name.
**Bit2Me**
```python
await sdk.cancel_open_orders('bit2me:spot:BTC/EUR')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**Bybit**
```python
await sdk.cancel_open_orders('bybit:spot:BTCUSDT')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**Coinbase**
```python
await sdk.cancel_open_orders('coinbase:spot:BTC-USD')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**dYdX**
```python
await sdk.cancel_open_orders('dydx:perp:BTC-USD')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**Hyperliquid**
```python
await sdk.cancel_open_orders('hyperliquid:spot:UBTC/USDC:142')
print('Cancellation request completed')
```
```
Cancellation request completed
```
**MEXC**
```python
await sdk.cancel_open_orders('mexc:spot:BTCUSDT')
print('Cancellation request completed')
```
```
Cancellation request completed
```
### Perpetual-only
#### `index`
```python
index(market_id, /) -> Decimal
```
Fetch the market index (oracle) price.
**Binance**
```python
price = await sdk.index('binance:usdm:BTCUSDT')
```
```
Decimal('60120.00')
```
**Bitget**
```python
price = await sdk.index('bitget:usdt:BTCUSDT')
```
```
Decimal('60120.00')
```
**Bybit**
```python
price = await sdk.index('bybit:perp:BTCUSDT')
```
```
Decimal('60120.00')
```
**Coinbase**
```python
price = await sdk.index('coinbase:intx:BTC-PERP-INTX')
```
```
Decimal('60120.00')
```
**dYdX**
```python
price = await sdk.index('dydx:perp:BTC-USD')
```
```
Decimal('60120.00')
```
**Hyperliquid**
```python
price = await sdk.index('hyperliquid::BTC')
```
```
Decimal('60110.50')
```
**Kraken**
```python
price = await sdk.index('kraken:perp:PF_XBTUSD')
```
```
Decimal('60120.00')
```
**KuCoin**
```python
price = await sdk.index('kucoin:perp:XBTUSDTM')
```
```
Decimal('60120.00')
```
**MEXC**
```python
price = await sdk.index('mexc:perp:BTC_USDT')
```
```
Decimal('60120.00')
```
#### `next_funding`
```python
next_funding(market_id, /) -> NextFunding
```
Fetch the upcoming funding `rate`, `time` and `interval`.
`.annualized` extrapolates the rate to a yearly figure.
**Binance**
```python
funding = await sdk.next_funding('binance:usdm:BTCUSDT')
print(funding.rate, funding.annualized)
```
```
0.0001 0.1095
```
**Bitget**
```python
funding = await sdk.next_funding('bitget:usdt:BTCUSDT')
print(funding.rate, funding.annualized)
```
```
0.0001 0.1095
```
**Bybit**
```python
funding = await sdk.next_funding('bybit:perp:BTCUSDT')
print(funding.rate, funding.annualized)
```
```
0.0001 0.1095
```
**Coinbase**
```python
funding = await sdk.next_funding('coinbase:intx:BTC-PERP-INTX')
print(funding.rate, funding.annualized)
```
```
0.0001 0.876
```
**dYdX**
```python
funding = await sdk.next_funding('dydx:perp:BTC-USD')
print(funding.rate, funding.annualized)
```
```
0.0001 0.876
```
**Hyperliquid**
```python
funding = await sdk.next_funding('hyperliquid::BTC')
print(funding.rate, funding.annualized)
```
```
0.00012 1.0512
```
**KuCoin**
```python
funding = await sdk.next_funding('kucoin:perp:XBTUSDTM')
print(funding.rate, funding.annualized)
```
```
0.0001 0.1095
```
**MEXC**
```python
funding = await sdk.next_funding('mexc:perp:BTC_USDT')
print(funding.rate, funding.annualized)
```
```
0.0001 0.1095
```
#### `funding_rates`
```python
funding_rates(market_id, /, start=None, end=None) -> AsyncIterable[Sequence[FundingRate]]
```
Fetch the market's public funding rate history, paginated.
Each `FundingRate` may also carry the `premium` (mark vs. index) it was computed from.
**Args**
- `start`: Start of the window (inclusive). `None` fetches from the earliest available.
- `end`: End of the window (inclusive). `None` means everything since `start`.
**Binance**
```python
async for page in sdk.funding_rates('binance:usdm:BTCUSDT', start, end):
for rate in page:
print(rate.time, rate.rate)
```
```
2025-01-03 16:00:00 0.0001
2025-01-03 08:00:00 0.00012
```
**Bitget**
```python
async for page in sdk.funding_rates('bitget:usdt:BTCUSDT', start, end):
for rate in page:
print(rate.time, rate.rate)
```
```
2025-01-03 16:00:00 0.0001
2025-01-03 08:00:00 0.00012
```
**Bybit**
```python
async for page in sdk.funding_rates('bybit:perp:BTCUSDT', start, end):
for rate in page:
print(rate.time, rate.rate)
```
```
2025-01-03 16:00:00 0.0001
2025-01-03 08:00:00 0.00012
```
**Coinbase**
```python
async for page in sdk.funding_rates('coinbase:intx:BTC-PERP-INTX', start, end):
for rate in page:
print(rate.time, rate.rate)
```
```
2025-01-03 16:00:00 0.0001
2025-01-03 08:00:00 0.00012
```
**dYdX**
```python
async for page in sdk.funding_rates('dydx:perp:BTC-USD', start, end):
for rate in page:
print(rate.time, rate.rate)
```
```
2025-01-03 16:00:00 0.0001
2025-01-03 08:00:00 0.00012
```
**Hyperliquid**
```python
async for page in sdk.funding_rates('hyperliquid::BTC', start, end):
for rate in page:
print(rate.time, rate.rate)
```
```
2025-01-03 16:00:00 0.00012
2025-01-03 08:00:00 0.00011
```
**Kraken**
Native historical relative rates; SDK settlement time is period start plus one hour. Inclusive bounds apply to settlement time; an omitted start includes all retained rows.
```python
async for page in sdk.funding_rates('kraken:perp:PF_XBTUSD', start, end):
for rate in page:
print(rate.time, rate.rate)
```
```
2025-01-03 16:00:00 0.0001
2025-01-03 08:00:00 0.00012
```
**KuCoin**
```python
async for page in sdk.funding_rates('kucoin:perp:XBTUSDTM', start, end):
for rate in page:
print(rate.time, rate.rate)
```
```
2025-01-03 16:00:00 0.0001
2025-01-03 08:00:00 0.00012
```
**MEXC**
```python
async for page in sdk.funding_rates('mexc:perp:BTC_USDT', start, end):
for rate in page:
print(rate.time, rate.rate)
```
```
2025-01-03 16:00:00 0.0001
2025-01-03 08:00:00 0.00012
```
#### `funding_payments`
```python
funding_payments(market_id, /, start, end) -> AsyncIterable[Sequence[FundingPayment]]
```
Fetch your own settled funding cashflows over a window, paginated.
Paid is positive, received is negative, in quote units. Credential-scoped, unlike
`funding_rates`.
**Args**
- `start`: Start of the window (inclusive).
- `end`: End of the window (inclusive).
**Bybit**
```python
async for page in sdk.funding_payments('bybit:perp:BTCUSDT', start, end):
for payment in page:
print(payment.time, payment.amount)
```
```
2025-01-03 16:00:00 -1.24
2025-01-03 08:00:00 0.86
```
**dYdX**
```python
async for page in sdk.funding_payments('dydx:perp:BTC-USD', start, end):
for payment in page:
print(payment.time, payment.amount)
```
```
2025-01-03 16:00:00 -1.24
2025-01-03 08:00:00 0.86
```
**Hyperliquid**
```python
async for page in sdk.funding_payments('hyperliquid::BTC', start, end):
for payment in page:
print(payment.time, payment.amount)
```
```
2025-01-03 16:00:00 -1.05
2025-01-03 08:00:00 0.74
```
#### `perp_position`
```python
perp_position(market_id, /) -> PerpPosition
```
Fetch your open perpetual position: signed `size` plus average `entry_price`.
**Bitget**
```python
pos = await sdk.perp_position('bitget:usdt:BTCUSDT')
```
```
PerpPosition(size=Decimal('0.5'), entry_price=Decimal('58230.10'))
```
**Bybit**
```python
pos = await sdk.perp_position('bybit:perp:BTCUSDT')
```
```
PerpPosition(size=Decimal('0.5'), entry_price=Decimal('58230.10'))
```
**Coinbase**
```python
pos = await sdk.perp_position('coinbase:intx:BTC-PERP-INTX')
```
```
PerpPosition(size=Decimal('0.5'), entry_price=Decimal('58230.10'))
```
**dYdX**
```python
pos = await sdk.perp_position('dydx:perp:BTC-USD')
```
```
PerpPosition(size=Decimal('0.5'), entry_price=Decimal('58230.10'))
```
**Hyperliquid**
```python
pos = await sdk.perp_position('hyperliquid::BTC')
```
```
PerpPosition(size=Decimal('0.3'), entry_price=Decimal('58190.40'))
```
#### `perp_collateral`
```python
perp_collateral(id, /) -> PerpCollateral
```
Fetch the perpetual collateral bucket, with maintenance-margin risk fields.
Same bucket model and routing as `collateral()`, plus `initial_margin`,
`maintenance_margin`, `leverage`, `margin_mode`, and the `initial_ratio` and
`maintenance_ratio` properties. You can't open more at `initial_ratio >= 1`;
liquidation is at `maintenance_ratio >= 1`.
**Args**
- `id`: `:` for the exchange bucket, or
`::` for the bucket backing that market.
**Bitget**
```python
c = await sdk.perp_collateral('bitget:usdt:BTCUSDT')
print(c.maintenance_ratio)
```
```
PerpCollateral(equity=Decimal('10240.55'), leverage=Decimal('2.10'), ...)
0.183 # maintenance_ratio -- liquidation at 1.0
```
**Bybit**
```python
c = await sdk.perp_collateral('bybit:perp:BTCUSDT')
print(c.maintenance_ratio)
```
```
PerpCollateral(equity=Decimal('10240.55'), leverage=Decimal('2.10'), ...)
0.183 # maintenance_ratio -- liquidation at 1.0
```
**Coinbase**
```python
c = await sdk.perp_collateral('coinbase:intx:BTC-PERP-INTX')
print(c.maintenance_ratio)
```
```
PerpCollateral(equity=Decimal('10240.55'), leverage=Decimal('2.10'), ...)
0.183 # maintenance_ratio -- liquidation at 1.0
```
**dYdX**
```python
c = await sdk.perp_collateral('dydx:perp:BTC-USD')
print(c.maintenance_ratio)
```
```
PerpCollateral(equity=Decimal('10240.55'), leverage=Decimal('2.10'), ...)
0.183 # maintenance_ratio -- liquidation at 1.0
```
**Hyperliquid**
```python
c = await sdk.perp_collateral('hyperliquid::BTC')
print(c.maintenance_ratio)
```
```
PerpCollateral(equity=Decimal('9875.20'), leverage=Decimal('1.85'), ...)
0.201 # maintenance_ratio -- liquidation at 1.0
```