Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 1.6 KB

OrderBookApi.md

File metadata and controls

58 lines (37 loc) · 1.6 KB
Raw

SwaggerClient::OrderBookApi

All URIs are relative to https://localhost/api/v1

Method HTTP request Description
order_book_get_l2 GET /orderBook/L2 Get current orderbook in vertical format.

order_book_get_l2

Array<OrderBookL2> order_book_get_l2(symbol, opts)

Get current orderbook in vertical format.

Example

# load the gem
require 'swagger_client'

api_instance = SwaggerClient::OrderBookApi.new

symbol = 'symbol_example' # String | Instrument symbol. Send a series (e.g. XBT) to get data for the nearest contract in that series.

opts = { 
  depth: 25 # Float | Orderbook depth per side. Send 0 for full depth.
}

begin
  #Get current orderbook in vertical format.
  result = api_instance.order_book_get_l2(symbol, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling OrderBookApi->order_book_get_l2: #{e}"
end

Parameters

Name Type Description Notes
symbol String Instrument symbol. Send a series (e.g. XBT) to get data for the nearest contract in that series.
depth Float Orderbook depth per side. Send 0 for full depth. [optional] [default to 25]

Return type

Array<OrderBookL2>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript