Attributes
- Companion:
- object
- Graph
- Supertypes
Members list
Type members
Types
Value members
Concrete methods
The Aggregate Trade Streams push trade information that is aggregated for a single taker order every 100 milliseconds.
The Aggregate Trade Streams push trade information that is aggregated for a single taker order every 100 milliseconds.
Attributes
- symbol
the symbol
- Returns:
a stream of aggregate trade events
Pushes any update to the best bid or ask's price or quantity in real-time for all selected symbols.
Pushes any update to the best bid or ask's price or quantity in real-time for all selected symbols.
Attributes
- symbols
the symbols
- Returns:
a stream of best bid or ask's price or quantity for all symbols
Order book price and quantity depth updates used to locally manage an order book.
Order book price and quantity depth updates used to locally manage an order book.
Attributes
- symbol
the symbol
- Returns:
a stream of order book price and quantity depth updates
The Kline/Candlestick Stream push updates to the current klines/candlestick periodically. In an actively traded symbol, the stream seems to push updates every two seconds. In a less actively traded symbol, there may be longer gaps of 10 secs or more between updates, and updates intervals will not be regularly spaced.
The Kline/Candlestick Stream push updates to the current klines/candlestick periodically. In an actively traded symbol, the stream seems to push updates every two seconds. In a less actively traded symbol, there may be longer gaps of 10 secs or more between updates, and updates intervals will not be regularly spaced.
Attributes
- interval
the interval
- symbol
the symbol
- Returns:
a stream of klines
Top bids and asks
Top bids and asks
Attributes
- level
the level
- symbol
the symbol
- Returns:
a stream of top bids and asks
The Trade Streams push raw trade information; each trade has a unique buyer and seller.
The Trade Streams push raw trade information; each trade has a unique buyer and seller.
Attributes
- symbol
the symbol
- Returns:
a stream of trades
Deprecated methods
Cancels all orders of a symbol.
Cancels all orders of a symbol.
Attributes
- orderCancel
the parameters required to cancel all the orders
- Returns:
currently nothing
- Deprecated
- true
Cancels an order.
Cancels an order.
Attributes
- orderCancel
the parameters required to cancel the order
- Returns:
currently nothing
- Deprecated
- true
Creates an order.
Creates an order.
Attributes
- orderCreate
the parameters required to define the order
- Returns:
The id of the order created
- Deprecated
- true
Returns the current balance, at the time the query is executed.
Returns the current balance, at the time the query is executed.
Attributes
- Returns:
The account information including the balance (free and locked) for each asset
- Deprecated
- true
Returns the depth of the orderbook.
Returns the depth of the orderbook.
Attributes
- query
an
Depthobject containing the query parameters- Returns:
the orderbook depth
- Deprecated
- true
Returns a stream of Kline objects. It recursively and lazily invokes the endpoint in case the result set doesn't fit in a single page.
Returns a stream of Kline objects. It recursively and lazily invokes the endpoint in case the result set doesn't fit in a single page.
Attributes
- query
an
KLinesobject containing the query parameters- Returns:
the stream of Kline objects
- Deprecated
- true
Returns a snapshot of the prices at the time the query is executed.
Returns a snapshot of the prices at the time the query is executed.
Attributes
- Returns:
A sequence of prices (one for each symbol)
- Deprecated
- true
Queries the status and fill price of an existing order.
Queries the status and fill price of an existing order.
Attributes
- orderQuery
The order must be identified by Symbol plus one of OrderId or ClientOrderId
- Returns:
Attributes of the order including status, fill amount and filled price.
- Deprecated
- true
Inherited methods
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Concrete fields
API V3
API V3