Skip to content

Commit 92d0879

Browse files
revilwangrevilwang
committed
add missing model documents
1 parent df22b58 commit 92d0879

13 files changed

Lines changed: 207 additions & 0 deletions

‎docs/Contract.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contract
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | Futures name | [optional]
7+
**type** | **str** | Futures type | [optional]
8+
**quanto_multiplier** | **str** | Multiplier used in converting from invoicing to settlement currency in quanto futures | [optional]
9+
**leverage_min** | **str** | minimum leverage | [optional]
10+
**leverage_max** | **str** | maximum leverage | [optional]
11+
**mark_type** | **str** | mark price type, internal - based on internal trading, index - based on external index price | [optional]
12+
**mark_price** | **str** | latest mark price | [optional]
13+
**index_price** | **str** | latest index price | [optional]
14+
**maintenance_rate** | **str** | maintenance rate of margin | [optional]
15+
**funding_rate** | **str** | funding rate | [optional]
16+
**funding_interval** | **int** | funding application interval, unit in seconds | [optional]
17+
**funding_next_apply** | **float** | next funding time | [optional]
18+
**risk_limit_base** | **str** | risk limit base | [optional]
19+
**risk_limit_step** | **str** | step of adjusting risk limit | [optional]
20+
**risk_limit_max** | **str** | maximum risk limit the contract allowed | [optional]
21+
**order_size_min** | **int** | minimum order size the contract allowed | [optional]
22+
**order_size_max** | **int** | maximum order size the contract allowed | [optional]
23+
**order_price_deviate** | **str** | deviation between order price and current index price. If price of an order is denoted as `order_price`, it must meet the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate | [optional]
24+
25+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
26+
27+

‎docs/FundingRateRecord.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# FundingRateRecord
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**t** | **int** | Unix timestamp in seconds | [optional]
7+
**r** | **str** | funding rate | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/FuturesAccount.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# FuturesAccount
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**total** | **str** | total assets, total = position_margin + order_margin + available | [optional]
7+
**unrealised_pnl** | **str** | unrealized pnl | [optional]
8+
**position_margin** | **str** | position margin | [optional]
9+
**order_margin** | **str** | order margin of unfinished orders | [optional]
10+
**available** | **str** | available balance to transfer out or trade | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/FuturesCandlestick.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# FuturesCandlestick
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**t** | **float** | Unix timestamp in seconds | [optional]
7+
**v** | **int** | size volume. Only returned if `contract` is not prefixed | [optional]
8+
**c** | **str** | close price | [optional]
9+
**h** | **str** | highest price | [optional]
10+
**l** | **str** | lowest price | [optional]
11+
**o** | **str** | open price | [optional]
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+

‎docs/FuturesErrorResponse.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# FuturesErrorResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**label** | **str** | 错误标识符，错误描述如下： 请求参数或格式问题: - INVALID_PARAM_VALUE: 参数输入值无效 - INVALID_REQUEST_BODY: 无效请求体 - MISSING_REQUIRED_PARAM: 缺少必选参数 - DUPLICATE_REQUEST: 请求过于频繁 认证相关: - INVALID_CREDENTIALS: 认证接口缺少用户认证信息 - NO_FUTURES_ACCOUNT: 用户无期货账户 业务相关: - NO_MATCHING: 没有匹配的对手单 - NO_MARKING_PRICE: 合约当前无标记价格 - CONTRACT_NOT_FOUND: 合约未找到 - NOT_FOUND: 请求路径不存在 - RISK_LIMIT_EXCEEDED: 委托超出风险限额 - INSUFFICIENT_BALANCE: 余额不足 - POTENTIAL_LIQUIDATION: 操作可能导致爆仓 - LEVERAGE_TOO_HIGH: 杠杆倍数设置过高 - LEVERAGE_TOO_LOW: 杠杆倍数设置过低 - ORDER_NOT_FOUND: 委托不存在 - ORDER_FINISHED: 订单已结束 - TOO_MANY_ORDERS: 过多未交易的挂单 - POSITION_NOT_FOUND: 合约无头寸信息 - POSITION_CROSS_MARGIN: 全仓不支持更新保证金 - POSITION_LOCKED: 头寸当前被锁定 - TOO_MUCH_CHANGE: 保证金超过可调范围 - RISK_LIMIT_NOT_MULTIPLE: 风险限额未按照步长调整 - RISK_LIMIT_TOO_HIGH: 超出最大风险限额 - RISK_LIMIT_TOO_lOW: 风险限额设置过低 - PRICE_TOO_DEVIATED: 下单价与标记价格相差过大 - SIZE_TOO_LARGE: 下单数量超过上限 - SIZE_TOO_SMALL: 下单数量不足下限 - LIQUIDATION_PRICE_EXCEEDED: 补仓时价格不能超过平仓价 - POSITION_IN_CLOSE: 仓位正在平仓 - POTENTIAL_BANKRUPTCY: 下单若成交，保证金无法弥补损失 服务异常： - SERVER_ERROR: 内部错误 - TOO_BUSY: 服务当前忙 | [optional]
7+
**message** | **str** | 详细错误描述。如果指定了 `Accept-Language` 请求头部，且支持指定语言，则描述信息会返回对应的语言 | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/FuturesOrder.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# FuturesOrder
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **int** | futures order ID | [optional]
7+
**create_time** | **float** | order creation time | [optional]
8+
**finish_time** | **float** | order finished time. Not returned if order is open | [optional]
9+
**finish_as** | **str** | how the order is finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL | [optional]
10+
**status** | **str** | order status - `open`: waiting to be traded - `finished`: finished | [optional]
11+
**contract** | **str** | contract name |
12+
**size** | **int** | contract size. Specify positive number to make a bid, negative number otherwise. Set to 0 if trying to close the position | [optional]
13+
**price** | **str** | order price. Set to 0 if using market price | [optional]
14+
**close** | **bool** | set to true if trying to close the position | [optional] [default to False]
15+
**is_close** | **bool** | the order is a closing position order. | [optional]
16+
**tif** | **str** | Time in force. If using market price, only `ioc` is supported. - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled | [optional] [default to 'gtc']
17+
**left** | **int** | size left to be traded | [optional]
18+
**fill_price** | **str** | fill price of the order | [optional]
19+
**text** | **str** | how order is created - web: from web - api: from API - app: from mobile phones - auto_deleveraging: from ADL - liquidation: from liquidation - insurance: from insurance | [optional]
20+
21+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
22+
23+

‎docs/FuturesOrderBook.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# FuturesOrderBook
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**asks** | [**list[FuturesOrderBookItem]**](FuturesOrderBookItem.md) | asks order depth |
7+
**bids** | [**list[FuturesOrderBookItem]**](FuturesOrderBookItem.md) | bids order depth |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/FuturesOrderBookItem.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# FuturesOrderBookItem
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**p** | **str** | price | [optional]
7+
**s** | **int** | size | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/FuturesTicker.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# FuturesTicker
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**contract** | **str** | contract name | [optional]
7+
**last** | **str** | last trading price | [optional]
8+
**change_percentage** | **str** | change percentage | [optional]
9+
**total_size** | **str** | contract total size | [optional]
10+
**volume_24h** | **str** | trade size in recent 24h | [optional]
11+
**mark_price** | **str** | recent mark price | [optional]
12+
**funding_rate** | **str** | funding rate | [optional]
13+
**index_price** | **str** | index price | [optional]
14+
15+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16+
17+

‎docs/FuturesTrade.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# FuturesTrade
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **int** | trade ID | [optional]
7+
**create_time** | **float** | trading time | [optional]
8+
**contract** | **str** | futures contrat | [optional]
9+
**size** | **int** | trading size | [optional]
10+
**price** | **str** | trading price | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

0 commit comments

Comments
 (0)