All URIs are relative to https://www.deribit.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| private_buy_get | GET /private/buy | Places a buy order for an instrument. |
| private_cancel_all_by_currency_get | GET /private/cancel_all_by_currency | Cancels all orders by currency, optionally filtered by instrument kind and/or order type. |
| private_cancel_all_by_instrument_get | GET /private/cancel_all_by_instrument | Cancels all orders by instrument, optionally filtered by order type. |
| private_cancel_all_get | GET /private/cancel_all | This method cancels all users orders and stop orders within all currencies and instrument kinds. |
| private_cancel_get | GET /private/cancel | Cancel an order, specified by order id |
| private_close_position_get | GET /private/close_position | Makes closing position reduce only order . |
| private_edit_get | GET /private/edit | Change price, amount and/or other properties of an order. |
| private_get_margins_get | GET /private/get_margins | Get margins for given instrument, amount and price. |
| private_get_open_orders_by_currency_get | GET /private/get_open_orders_by_currency | Retrieves list of user's open orders. |
| private_get_open_orders_by_instrument_get | GET /private/get_open_orders_by_instrument | Retrieves list of user's open orders within given Instrument. |
| private_get_order_history_by_currency_get | GET /private/get_order_history_by_currency | Retrieves history of orders that have been partially or fully filled. |
| private_get_order_history_by_instrument_get | GET /private/get_order_history_by_instrument | Retrieves history of orders that have been partially or fully filled. |
| private_get_order_margin_by_ids_get | GET /private/get_order_margin_by_ids | Retrieves initial margins of given orders |
| private_get_order_state_get | GET /private/get_order_state | Retrieve the current state of an order. |
| private_get_settlement_history_by_currency_get | GET /private/get_settlement_history_by_currency | Retrieves settlement, delivery and bankruptcy events that have affected your account. |
| private_get_settlement_history_by_instrument_get | GET /private/get_settlement_history_by_instrument | Retrieves public settlement, delivery and bankruptcy events filtered by instrument name |
| private_get_user_trades_by_currency_and_time_get | GET /private/get_user_trades_by_currency_and_time | Retrieve the latest user trades that have occurred for instruments in a specific currency symbol and within given time range. |
| private_get_user_trades_by_currency_get | GET /private/get_user_trades_by_currency | Retrieve the latest user trades that have occurred for instruments in a specific currency symbol. |
| private_get_user_trades_by_instrument_and_time_get | GET /private/get_user_trades_by_instrument_and_time | Retrieve the latest user trades that have occurred for a specific instrument and within given time range. |
| private_get_user_trades_by_instrument_get | GET /private/get_user_trades_by_instrument | Retrieve the latest user trades that have occurred for a specific instrument. |
| private_get_user_trades_by_order_get | GET /private/get_user_trades_by_order | Retrieve the list of user trades that was created for given order |
| private_sell_get | GET /private/sell | Places a sell order for an instrument. |
object private_buy_get(instrument_name, amount, type=type, label=label, price=price, time_in_force=time_in_force, max_show=max_show, post_only=post_only, reduce_only=reduce_only, stop_price=stop_price, trigger=trigger, advanced=advanced)
Places a buy order for an instrument.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
amount = 3.4 # float | It represents the requested order size. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH
type = 'type_example' # str | The order type, default: `\"limit\"` (optional)
label = 'label_example' # str | user defined label for the order (maximum 32 characters) (optional)
price = 3.4 # float | <p>The order price in base currency (Only for limit and stop_limit orders)</p> <p>When adding order with advanced=usd, the field price should be the option price value in USD.</p> <p>When adding order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%</p> (optional)
time_in_force = 'good_til_cancelled' # str | <p>Specifies how long the order remains in effect. Default `\"good_til_cancelled\"`</p> <ul> <li>`\"good_til_cancelled\"` - unfilled order remains in order book until cancelled</li> <li>`\"fill_or_kill\"` - execute a transaction immediately and completely or not at all</li> <li>`\"immediate_or_cancel\"` - execute a transaction immediately, and any portion of the order that cannot be immediately filled is cancelled</li> </ul> (optional) (default to 'good_til_cancelled')
max_show = 1 # float | Maximum amount within an order to be shown to other customers, `0` for invisible order (optional) (default to 1)
post_only = True # bool | <p>If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the bid.</p> <p>Only valid in combination with time_in_force=`\"good_til_cancelled\"`</p> (optional) (default to True)
reduce_only = False # bool | If `true`, the order is considered reduce-only which is intended to only reduce a current position (optional) (default to False)
stop_price = 3.4 # float | Stop price, required for stop limit orders (Only for stop orders) (optional)
trigger = 'trigger_example' # str | Defines trigger type, required for `\"stop_limit\"` order type (optional)
advanced = 'advanced_example' # str | Advanced option order type. (Only for options) (optional)
try:
# Places a buy order for an instrument.
api_response = api_instance.private_buy_get(instrument_name, amount, type=type, label=label, price=price, time_in_force=time_in_force, max_show=max_show, post_only=post_only, reduce_only=reduce_only, stop_price=stop_price, trigger=trigger, advanced=advanced)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_buy_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| amount | float | It represents the requested order size. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH | |
| type | str | The order type, default: `"limit"` | [optional] |
| label | str | user defined label for the order (maximum 32 characters) | [optional] |
| price | float | <p>The order price in base currency (Only for limit and stop_limit orders)</p> <p>When adding order with advanced=usd, the field price should be the option price value in USD.</p> <p>When adding order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%</p> | [optional] |
| time_in_force | str | <p>Specifies how long the order remains in effect. Default `"good_til_cancelled"`</p> <ul> <li>`"good_til_cancelled"` - unfilled order remains in order book until cancelled</li> <li>`"fill_or_kill"` - execute a transaction immediately and completely or not at all</li> <li>`"immediate_or_cancel"` - execute a transaction immediately, and any portion of the order that cannot be immediately filled is cancelled</li> </ul> | [optional] [default to 'good_til_cancelled'] |
| max_show | float | Maximum amount within an order to be shown to other customers, `0` for invisible order | [optional] [default to 1] |
| post_only | bool | <p>If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the bid.</p> <p>Only valid in combination with time_in_force=`"good_til_cancelled"`</p> | [optional] [default to True] |
| reduce_only | bool | If `true`, the order is considered reduce-only which is intended to only reduce a current position | [optional] [default to False] |
| stop_price | float | Stop price, required for stop limit orders (Only for stop orders) | [optional] |
| trigger | str | Defines trigger type, required for `"stop_limit"` order type | [optional] |
| advanced | str | Advanced option order type. (Only for options) | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | ok response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_cancel_all_by_currency_get(currency, kind=kind, type=type)
Cancels all orders by currency, optionally filtered by instrument kind and/or order type.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
currency = 'currency_example' # str | The currency symbol
kind = 'kind_example' # str | Instrument kind, if not provided instruments of all kinds are considered (optional)
type = 'type_example' # str | Order type - limit, stop or all, default - `all` (optional)
try:
# Cancels all orders by currency, optionally filtered by instrument kind and/or order type.
api_response = api_instance.private_cancel_all_by_currency_get(currency, kind=kind, type=type)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_cancel_all_by_currency_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| currency | str | The currency symbol | |
| kind | str | Instrument kind, if not provided instruments of all kinds are considered | [optional] |
| type | str | Order type - limit, stop or all, default - `all` | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_cancel_all_by_instrument_get(instrument_name, type=type)
Cancels all orders by instrument, optionally filtered by order type.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
type = 'type_example' # str | Order type - limit, stop or all, default - `all` (optional)
try:
# Cancels all orders by instrument, optionally filtered by order type.
api_response = api_instance.private_cancel_all_by_instrument_get(instrument_name, type=type)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_cancel_all_by_instrument_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| type | str | Order type - limit, stop or all, default - `all` | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_cancel_all_get()
This method cancels all users orders and stop orders within all currencies and instrument kinds.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
try:
# This method cancels all users orders and stop orders within all currencies and instrument kinds.
api_response = api_instance.private_cancel_all_get()
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_cancel_all_get: %s\n" % e)This endpoint does not need any parameter.
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_cancel_get(order_id)
Cancel an order, specified by order id
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
order_id = 'ETH-100234' # str | The order id
try:
# Cancel an order, specified by order id
api_response = api_instance.private_cancel_get(order_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_cancel_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| order_id | str | The order id |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_close_position_get(instrument_name, type, price=price)
Makes closing position reduce only order .
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
type = 'type_example' # str | The order type
price = 3.4 # float | Optional price for limit order. (optional)
try:
# Makes closing position reduce only order .
api_response = api_instance.private_close_position_get(instrument_name, type, price=price)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_close_position_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| type | str | The order type | |
| price | float | Optional price for limit order. | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | ok response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_edit_get(order_id, amount, price, post_only=post_only, advanced=advanced, stop_price=stop_price)
Change price, amount and/or other properties of an order.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
order_id = 'ETH-100234' # str | The order id
amount = 3.4 # float | It represents the requested order size. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH
price = 3.4 # float | <p>The order price in base currency.</p> <p>When editing an option order with advanced=usd, the field price should be the option price value in USD.</p> <p>When editing an option order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%</p>
post_only = True # bool | <p>If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the bid.</p> <p>Only valid in combination with time_in_force=`\"good_til_cancelled\"`</p> (optional) (default to True)
advanced = 'advanced_example' # str | Advanced option order type. If you have posted an advanced option order, it is necessary to re-supply this parameter when editing it (Only for options) (optional)
stop_price = 3.4 # float | Stop price, required for stop limit orders (Only for stop orders) (optional)
try:
# Change price, amount and/or other properties of an order.
api_response = api_instance.private_edit_get(order_id, amount, price, post_only=post_only, advanced=advanced, stop_price=stop_price)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_edit_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| order_id | str | The order id | |
| amount | float | It represents the requested order size. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH | |
| price | float | <p>The order price in base currency.</p> <p>When editing an option order with advanced=usd, the field price should be the option price value in USD.</p> <p>When editing an option order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%</p> | |
| post_only | bool | <p>If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the bid.</p> <p>Only valid in combination with time_in_force=`"good_til_cancelled"`</p> | [optional] [default to True] |
| advanced | str | Advanced option order type. If you have posted an advanced option order, it is necessary to re-supply this parameter when editing it (Only for options) | [optional] |
| stop_price | float | Stop price, required for stop limit orders (Only for stop orders) | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_margins_get(instrument_name, amount, price)
Get margins for given instrument, amount and price.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
amount = 1 # float | Amount, integer for future, float for option. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH.
price = 3.4 # float | Price
try:
# Get margins for given instrument, amount and price.
api_response = api_instance.private_get_margins_get(instrument_name, amount, price)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_margins_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| amount | float | Amount, integer for future, float for option. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH. | |
| price | float | Price |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_open_orders_by_currency_get(currency, kind=kind, type=type)
Retrieves list of user's open orders.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
currency = 'currency_example' # str | The currency symbol
kind = 'kind_example' # str | Instrument kind, if not provided instruments of all kinds are considered (optional)
type = 'type_example' # str | Order type, default - `all` (optional)
try:
# Retrieves list of user's open orders.
api_response = api_instance.private_get_open_orders_by_currency_get(currency, kind=kind, type=type)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_open_orders_by_currency_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| currency | str | The currency symbol | |
| kind | str | Instrument kind, if not provided instruments of all kinds are considered | [optional] |
| type | str | Order type, default - `all` | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_open_orders_by_instrument_get(instrument_name, type=type)
Retrieves list of user's open orders within given Instrument.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
type = 'type_example' # str | Order type, default - `all` (optional)
try:
# Retrieves list of user's open orders within given Instrument.
api_response = api_instance.private_get_open_orders_by_instrument_get(instrument_name, type=type)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_open_orders_by_instrument_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| type | str | Order type, default - `all` | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_order_history_by_currency_get(currency, kind=kind, count=count, offset=offset, include_old=include_old, include_unfilled=include_unfilled)
Retrieves history of orders that have been partially or fully filled.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
currency = 'currency_example' # str | The currency symbol
kind = 'kind_example' # str | Instrument kind, if not provided instruments of all kinds are considered (optional)
count = 56 # int | Number of requested items, default - `20` (optional)
offset = 10 # int | The offset for pagination, default - `0` (optional)
include_old = false # bool | Include in result orders older than 2 days, default - `false` (optional)
include_unfilled = false # bool | Include in result fully unfilled closed orders, default - `false` (optional)
try:
# Retrieves history of orders that have been partially or fully filled.
api_response = api_instance.private_get_order_history_by_currency_get(currency, kind=kind, count=count, offset=offset, include_old=include_old, include_unfilled=include_unfilled)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_order_history_by_currency_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| currency | str | The currency symbol | |
| kind | str | Instrument kind, if not provided instruments of all kinds are considered | [optional] |
| count | int | Number of requested items, default - `20` | [optional] |
| offset | int | The offset for pagination, default - `0` | [optional] |
| include_old | bool | Include in result orders older than 2 days, default - `false` | [optional] |
| include_unfilled | bool | Include in result fully unfilled closed orders, default - `false` | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_order_history_by_instrument_get(instrument_name, count=count, offset=offset, include_old=include_old, include_unfilled=include_unfilled)
Retrieves history of orders that have been partially or fully filled.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
count = 56 # int | Number of requested items, default - `20` (optional)
offset = 10 # int | The offset for pagination, default - `0` (optional)
include_old = false # bool | Include in result orders older than 2 days, default - `false` (optional)
include_unfilled = false # bool | Include in result fully unfilled closed orders, default - `false` (optional)
try:
# Retrieves history of orders that have been partially or fully filled.
api_response = api_instance.private_get_order_history_by_instrument_get(instrument_name, count=count, offset=offset, include_old=include_old, include_unfilled=include_unfilled)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_order_history_by_instrument_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| count | int | Number of requested items, default - `20` | [optional] |
| offset | int | The offset for pagination, default - `0` | [optional] |
| include_old | bool | Include in result orders older than 2 days, default - `false` | [optional] |
| include_unfilled | bool | Include in result fully unfilled closed orders, default - `false` | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_order_margin_by_ids_get(ids)
Retrieves initial margins of given orders
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
ids = ['ids_example'] # list[str] | Ids of orders
try:
# Retrieves initial margins of given orders
api_response = api_instance.private_get_order_margin_by_ids_get(ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_order_margin_by_ids_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| ids | list[str] | Ids of orders |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_order_state_get(order_id)
Retrieve the current state of an order.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
order_id = 'ETH-100234' # str | The order id
try:
# Retrieve the current state of an order.
api_response = api_instance.private_get_order_state_get(order_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_order_state_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| order_id | str | The order id |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | ok response | - |
| 400 | result when used via rest/HTTP | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_settlement_history_by_currency_get(currency, type=type, count=count)
Retrieves settlement, delivery and bankruptcy events that have affected your account.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
currency = 'currency_example' # str | The currency symbol
type = 'type_example' # str | Settlement type (optional)
count = 56 # int | Number of requested items, default - `20` (optional)
try:
# Retrieves settlement, delivery and bankruptcy events that have affected your account.
api_response = api_instance.private_get_settlement_history_by_currency_get(currency, type=type, count=count)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_settlement_history_by_currency_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| currency | str | The currency symbol | |
| type | str | Settlement type | [optional] |
| count | int | Number of requested items, default - `20` | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_settlement_history_by_instrument_get(instrument_name, type=type, count=count)
Retrieves public settlement, delivery and bankruptcy events filtered by instrument name
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
type = 'type_example' # str | Settlement type (optional)
count = 56 # int | Number of requested items, default - `20` (optional)
try:
# Retrieves public settlement, delivery and bankruptcy events filtered by instrument name
api_response = api_instance.private_get_settlement_history_by_instrument_get(instrument_name, type=type, count=count)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_settlement_history_by_instrument_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| type | str | Settlement type | [optional] |
| count | int | Number of requested items, default - `20` | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_user_trades_by_currency_and_time_get(currency, start_timestamp, end_timestamp, kind=kind, count=count, include_old=include_old, sorting=sorting)
Retrieve the latest user trades that have occurred for instruments in a specific currency symbol and within given time range.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
currency = 'currency_example' # str | The currency symbol
start_timestamp = 1536569522277 # int | The earliest timestamp to return result for
end_timestamp = 1536569522277 # int | The most recent timestamp to return result for
kind = 'kind_example' # str | Instrument kind, if not provided instruments of all kinds are considered (optional)
count = 56 # int | Number of requested items, default - `10` (optional)
include_old = True # bool | Include trades older than 7 days, default - `false` (optional)
sorting = 'sorting_example' # str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) (optional)
try:
# Retrieve the latest user trades that have occurred for instruments in a specific currency symbol and within given time range.
api_response = api_instance.private_get_user_trades_by_currency_and_time_get(currency, start_timestamp, end_timestamp, kind=kind, count=count, include_old=include_old, sorting=sorting)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_user_trades_by_currency_and_time_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| currency | str | The currency symbol | |
| start_timestamp | int | The earliest timestamp to return result for | |
| end_timestamp | int | The most recent timestamp to return result for | |
| kind | str | Instrument kind, if not provided instruments of all kinds are considered | [optional] |
| count | int | Number of requested items, default - `10` | [optional] |
| include_old | bool | Include trades older than 7 days, default - `false` | [optional] |
| sorting | str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_user_trades_by_currency_get(currency, kind=kind, start_id=start_id, end_id=end_id, count=count, include_old=include_old, sorting=sorting)
Retrieve the latest user trades that have occurred for instruments in a specific currency symbol.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
currency = 'currency_example' # str | The currency symbol
kind = 'kind_example' # str | Instrument kind, if not provided instruments of all kinds are considered (optional)
start_id = 'start_id_example' # str | The ID number of the first trade to be returned (optional)
end_id = 'end_id_example' # str | The ID number of the last trade to be returned (optional)
count = 56 # int | Number of requested items, default - `10` (optional)
include_old = True # bool | Include trades older than 7 days, default - `false` (optional)
sorting = 'sorting_example' # str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) (optional)
try:
# Retrieve the latest user trades that have occurred for instruments in a specific currency symbol.
api_response = api_instance.private_get_user_trades_by_currency_get(currency, kind=kind, start_id=start_id, end_id=end_id, count=count, include_old=include_old, sorting=sorting)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_user_trades_by_currency_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| currency | str | The currency symbol | |
| kind | str | Instrument kind, if not provided instruments of all kinds are considered | [optional] |
| start_id | str | The ID number of the first trade to be returned | [optional] |
| end_id | str | The ID number of the last trade to be returned | [optional] |
| count | int | Number of requested items, default - `10` | [optional] |
| include_old | bool | Include trades older than 7 days, default - `false` | [optional] |
| sorting | str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_user_trades_by_instrument_and_time_get(instrument_name, start_timestamp, end_timestamp, count=count, include_old=include_old, sorting=sorting)
Retrieve the latest user trades that have occurred for a specific instrument and within given time range.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
start_timestamp = 1536569522277 # int | The earliest timestamp to return result for
end_timestamp = 1536569522277 # int | The most recent timestamp to return result for
count = 56 # int | Number of requested items, default - `10` (optional)
include_old = True # bool | Include trades older than 7 days, default - `false` (optional)
sorting = 'sorting_example' # str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) (optional)
try:
# Retrieve the latest user trades that have occurred for a specific instrument and within given time range.
api_response = api_instance.private_get_user_trades_by_instrument_and_time_get(instrument_name, start_timestamp, end_timestamp, count=count, include_old=include_old, sorting=sorting)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_user_trades_by_instrument_and_time_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| start_timestamp | int | The earliest timestamp to return result for | |
| end_timestamp | int | The most recent timestamp to return result for | |
| count | int | Number of requested items, default - `10` | [optional] |
| include_old | bool | Include trades older than 7 days, default - `false` | [optional] |
| sorting | str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_user_trades_by_instrument_get(instrument_name, start_seq=start_seq, end_seq=end_seq, count=count, include_old=include_old, sorting=sorting)
Retrieve the latest user trades that have occurred for a specific instrument.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
start_seq = 56 # int | The sequence number of the first trade to be returned (optional)
end_seq = 56 # int | The sequence number of the last trade to be returned (optional)
count = 56 # int | Number of requested items, default - `10` (optional)
include_old = True # bool | Include trades older than 7 days, default - `false` (optional)
sorting = 'sorting_example' # str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) (optional)
try:
# Retrieve the latest user trades that have occurred for a specific instrument.
api_response = api_instance.private_get_user_trades_by_instrument_get(instrument_name, start_seq=start_seq, end_seq=end_seq, count=count, include_old=include_old, sorting=sorting)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_user_trades_by_instrument_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| start_seq | int | The sequence number of the first trade to be returned | [optional] |
| end_seq | int | The sequence number of the last trade to be returned | [optional] |
| count | int | Number of requested items, default - `10` | [optional] |
| include_old | bool | Include trades older than 7 days, default - `false` | [optional] |
| sorting | str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_get_user_trades_by_order_get(order_id, sorting=sorting)
Retrieve the list of user trades that was created for given order
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
order_id = 'ETH-100234' # str | The order id
sorting = 'sorting_example' # str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) (optional)
try:
# Retrieve the list of user trades that was created for given order
api_response = api_instance.private_get_user_trades_by_order_get(order_id, sorting=sorting)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_get_user_trades_by_order_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| order_id | str | The order id | |
| sorting | str | Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object private_sell_get(instrument_name, amount, type=type, label=label, price=price, time_in_force=time_in_force, max_show=max_show, post_only=post_only, reduce_only=reduce_only, stop_price=stop_price, trigger=trigger, advanced=advanced)
Places a sell order for an instrument.
- Bearer (Auth. Token) Authentication (bearerAuth):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure Bearer authorization (Auth. Token): bearerAuth
configuration.access_token = 'YOUR_BEARER_TOKEN'
# create an instance of the API class
api_instance = openapi_client.TradingApi(openapi_client.ApiClient(configuration))
instrument_name = 'BTC-PERPETUAL' # str | Instrument name
amount = 3.4 # float | It represents the requested order size. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH
type = 'type_example' # str | The order type, default: `\"limit\"` (optional)
label = 'label_example' # str | user defined label for the order (maximum 32 characters) (optional)
price = 3.4 # float | <p>The order price in base currency (Only for limit and stop_limit orders)</p> <p>When adding order with advanced=usd, the field price should be the option price value in USD.</p> <p>When adding order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%</p> (optional)
time_in_force = 'good_til_cancelled' # str | <p>Specifies how long the order remains in effect. Default `\"good_til_cancelled\"`</p> <ul> <li>`\"good_til_cancelled\"` - unfilled order remains in order book until cancelled</li> <li>`\"fill_or_kill\"` - execute a transaction immediately and completely or not at all</li> <li>`\"immediate_or_cancel\"` - execute a transaction immediately, and any portion of the order that cannot be immediately filled is cancelled</li> </ul> (optional) (default to 'good_til_cancelled')
max_show = 1 # float | Maximum amount within an order to be shown to other customers, `0` for invisible order (optional) (default to 1)
post_only = True # bool | <p>If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the bid.</p> <p>Only valid in combination with time_in_force=`\"good_til_cancelled\"`</p> (optional) (default to True)
reduce_only = False # bool | If `true`, the order is considered reduce-only which is intended to only reduce a current position (optional) (default to False)
stop_price = 3.4 # float | Stop price, required for stop limit orders (Only for stop orders) (optional)
trigger = 'trigger_example' # str | Defines trigger type, required for `\"stop_limit\"` order type (optional)
advanced = 'advanced_example' # str | Advanced option order type. (Only for options) (optional)
try:
# Places a sell order for an instrument.
api_response = api_instance.private_sell_get(instrument_name, amount, type=type, label=label, price=price, time_in_force=time_in_force, max_show=max_show, post_only=post_only, reduce_only=reduce_only, stop_price=stop_price, trigger=trigger, advanced=advanced)
pprint(api_response)
except ApiException as e:
print("Exception when calling TradingApi->private_sell_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| instrument_name | str | Instrument name | |
| amount | float | It represents the requested order size. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH | |
| type | str | The order type, default: `"limit"` | [optional] |
| label | str | user defined label for the order (maximum 32 characters) | [optional] |
| price | float | <p>The order price in base currency (Only for limit and stop_limit orders)</p> <p>When adding order with advanced=usd, the field price should be the option price value in USD.</p> <p>When adding order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%</p> | [optional] |
| time_in_force | str | <p>Specifies how long the order remains in effect. Default `"good_til_cancelled"`</p> <ul> <li>`"good_til_cancelled"` - unfilled order remains in order book until cancelled</li> <li>`"fill_or_kill"` - execute a transaction immediately and completely or not at all</li> <li>`"immediate_or_cancel"` - execute a transaction immediately, and any portion of the order that cannot be immediately filled is cancelled</li> </ul> | [optional] [default to 'good_til_cancelled'] |
| max_show | float | Maximum amount within an order to be shown to other customers, `0` for invisible order | [optional] [default to 1] |
| post_only | bool | <p>If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the bid.</p> <p>Only valid in combination with time_in_force=`"good_til_cancelled"`</p> | [optional] [default to True] |
| reduce_only | bool | If `true`, the order is considered reduce-only which is intended to only reduce a current position | [optional] [default to False] |
| stop_price | float | Stop price, required for stop limit orders (Only for stop orders) | [optional] |
| trigger | str | Defines trigger type, required for `"stop_limit"` order type | [optional] |
| advanced | str | Advanced option order type. (Only for options) | [optional] |
object
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | ok response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]