Skip to main content

Get Market

GET 
/v1/markets/:market_id

Get market data by market ID.

Request​

Path Parameters

    market_id stringrequired

    Market identification.

Query Parameters

    expand string

    Possible values: [ORDERBOOK, PRICES]

    Add a extra content to current response. It is necessary one key/value pair for each extra content. Ex: ?expand=CONTENT_1&expand=CONTENT_2

    order_book_max_depth int32

    Possible values: non-empty and <= 100 characters, >= 1 and <= 100

    When expanding ORDERBOOK, set the orderbook max depth. Default: 20.

Responses​

OK

Schema
    result object

    Data about a pair of assets available to be traded.

    id string

    Identification of a pair of assets to be traded.

    base_currency string

    The left side of the pair. It is the currency that will be aquired by paying with quote currency; or received when selling.

    quote_currency string

    The right side of the pair. It is the currency that will be payed to aquire the base currency; or payed when buying.

    minimum_order_size string

    Minimum necessary asset amount to create an order.

    increment_size string

    Minimum amount necessary to increment the order size.

    price_increment_size string

    Minimum amount necessary to increment the order price.

    market_order_tolerance number

    In percentage.

    If the size of your order were larger than the size of the order on top of the book, your order will match with more than one order to fill the requested amount.

    In this case, the system stops matching new orders if the value of these orders were greater than the value of the first order at the top of the book (when your order started to fill) plus the tolerance percentage of this field. Ex: best price on top of the book: 100 USD, "market_tolerance_order": 10, maximum price to be matched: 110 USD.

    enabled boolean

    If this market is enabled to trade.

Loading...