SwaggerClient::OrderApi

All URIs are relative to https://api.bybit.com

Method	HTTP request	Description
order_cancel	POST /v2/private/order/cancel	Get my active order list.
order_cancel_all	POST /v2/private/order/cancelAll	Get my active order list.
order_get_orders	GET /v2/private/order/list	Get my active order list.
order_new	POST /v2/private/order/create	Place active order
order_query	GET /v2/private/order	Get my active order list.
order_replace	POST /v2/private/order/replace	Replace active order. Only incomplete orders can be modified.

order_cancel

Object order_cancel(symbol, opts)

Get my active order list.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api_key'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['sign'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['sign'] = 'Bearer'

  # Configure API key authorization: timestamp
  config.api_key['timestamp'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['timestamp'] = 'Bearer'
end

api_instance = SwaggerClient::OrderApi.new

symbol = 'symbol_example' # String | Contract type.

opts = { 
  order_id: 'order_id_example', # String | Order ID
  order_link_id: 'order_link_id_example' # String | Order link id.
}

begin
  #Get my active order list.
  result = api_instance.order_cancel(symbol, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling OrderApi->order_cancel: #{e}"
end

Parameters

Name	Type	Description	Notes
symbol	String	Contract type.
order_id	String	Order ID	[optional]
order_link_id	String	Order link id.	[optional]

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

order_cancel_all

Object order_cancel_all(symbol)

Get my active order list.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api_key'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['sign'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['sign'] = 'Bearer'

  # Configure API key authorization: timestamp
  config.api_key['timestamp'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['timestamp'] = 'Bearer'
end

api_instance = SwaggerClient::OrderApi.new

symbol = 'symbol_example' # String | Contract type.


begin
  #Get my active order list.
  result = api_instance.order_cancel_all(symbol)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling OrderApi->order_cancel_all: #{e}"
end

Parameters

Name	Type	Description	Notes
symbol	String	Contract type.

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

order_get_orders

Object order_get_orders(symbol, opts)

Get my active order list.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api_key'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['sign'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['sign'] = 'Bearer'

  # Configure API key authorization: timestamp
  config.api_key['timestamp'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['timestamp'] = 'Bearer'
end

api_instance = SwaggerClient::OrderApi.new

symbol = 'symbol_example' # String | Contract type. Default BTCUSD

opts = { 
  limit: 8.14, # Float | TLimit for data size per page, max size is 50. Default as showing 20 pieces of data per page
  order_status: 'order_status_example', # String | Query your orders for all statuses if 'order_status' is empty. If you want to query orders with specific statuses , you can pass the order_status split by
  direction: 'direction_example', # String | Search direction. prev: prev page, next: next page. Defaults to next
  cursor: 'cursor_example' # String | Page turning mark，Use return cursor,Sign use origin data, in request please urlencode
}

begin
  #Get my active order list.
  result = api_instance.order_get_orders(symbol, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling OrderApi->order_get_orders: #{e}"
end

Parameters

Name	Type	Description	Notes
symbol	String	Contract type. Default BTCUSD
limit	Float	TLimit for data size per page, max size is 50. Default as showing 20 pieces of data per page	[optional]
order_status	String	Query your orders for all statuses if 'order_status' is empty. If you want to query orders with specific statuses , you can pass the order_status split by	[optional]
direction	String	Search direction. prev: prev page, next: next page. Defaults to next	[optional]
cursor	String	Page turning mark，Use return cursor,Sign use origin data, in request please urlencode	[optional]

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

order_new

Object order_new(side, symbol, order_type, qty, time_in_force, opts)

Place active order

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api_key'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['sign'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['sign'] = 'Bearer'

  # Configure API key authorization: timestamp
  config.api_key['timestamp'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['timestamp'] = 'Bearer'
end

api_instance = SwaggerClient::OrderApi.new

side = 'side_example' # String | Side

symbol = 'symbol_example' # String | Contract type.

order_type = 'order_type_example' # String | Active order type

qty = 8.14 # Float | 

time_in_force = 'time_in_force_example' # String | Time in force

opts = { 
  price: 1.2, # Float | Order price.
  take_profit: 1.2, # Float | take profit price
  stop_loss: 1.2, # Float | stop loss price
  reduce_only: true, # BOOLEAN | reduce only
  close_on_trigger: true, # BOOLEAN | close on trigger
  order_link_id: 'order_link_id_example' # String | TCustomized order ID, maximum length at 36 characters, and order ID under the same agency has to be unique.
}

begin
  #Place active order
  result = api_instance.order_new(side, symbol, order_type, qty, time_in_force, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling OrderApi->order_new: #{e}"
end

Parameters

Name	Type	Description	Notes
side	String	Side
symbol	String	Contract type.
order_type	String	Active order type
qty	Float
time_in_force	String	Time in force
price	Float	Order price.	[optional]
take_profit	Float	take profit price	[optional]
stop_loss	Float	stop loss price	[optional]
reduce_only	BOOLEAN	reduce only	[optional]
close_on_trigger	BOOLEAN	close on trigger	[optional]
order_link_id	String	TCustomized order ID, maximum length at 36 characters, and order ID under the same agency has to be unique.	[optional]

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

order_query

Object order_query(opts)

Get my active order list.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api_key'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['sign'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['sign'] = 'Bearer'

  # Configure API key authorization: timestamp
  config.api_key['timestamp'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['timestamp'] = 'Bearer'
end

api_instance = SwaggerClient::OrderApi.new

opts = { 
  order_id: 'order_id_example', # String | Order ID
  symbol: 'symbol_example' # String | Contract type. Default BTCUSD
}

begin
  #Get my active order list.
  result = api_instance.order_query(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling OrderApi->order_query: #{e}"
end

Parameters

Name	Type	Description	Notes
order_id	String	Order ID	[optional]
symbol	String	Contract type. Default BTCUSD	[optional]

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

order_replace

Object order_replace(symbol, opts)

Replace active order. Only incomplete orders can be modified.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api_key'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['sign'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['sign'] = 'Bearer'

  # Configure API key authorization: timestamp
  config.api_key['timestamp'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['timestamp'] = 'Bearer'
end

api_instance = SwaggerClient::OrderApi.new

symbol = 'symbol_example' # String | Contract type.

opts = { 
  order_id: 'order_id_example', # String | Order ID.
  order_link_id: 'order_link_id_example', # String | Order Link ID.
  p_r_qty: 'p_r_qty_example', # String | Order quantity.
  p_r_price: 'p_r_price_example' # String | Order price.
}

begin
  #Replace active order. Only incomplete orders can be modified. 
  result = api_instance.order_replace(symbol, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling OrderApi->order_replace: #{e}"
end

Parameters

Name	Type	Description	Notes
symbol	String	Contract type.
order_id	String	Order ID.	[optional]
order_link_id	String	Order Link ID.	[optional]
p_r_qty	String	Order quantity.	[optional]
p_r_price	String	Order price.	[optional]

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

Files

OrderApi.md

Latest commit

History

OrderApi.md

File metadata and controls

SwaggerClient::OrderApi

order_cancel

Example

Parameters

Return type

Authorization

HTTP request headers

order_cancel_all

Example

Parameters

Return type

Authorization

HTTP request headers

order_get_orders

Example

Parameters

Return type

Authorization

HTTP request headers

order_new

Example

Parameters

Return type

Authorization

HTTP request headers

order_query

Example

Parameters

Return type

Authorization

HTTP request headers

order_replace

Example

Parameters

Return type

Authorization

HTTP request headers