coinspot
coinspot cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
coinspot
Kind: global class
Extends: Exchange
- fetchBalance
- fetchOrderBook
- fetchTicker
- fetchTickers
- fetchTrades
- fetchMyTrades
- createOrder
- cancelOrder
fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of coinspot
Returns: object - a balance structure
See: https://www.coinspot.com.au/api#listmybalance
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
coinspot.fetchBalance (params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of coinspot
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://www.coinspot.com.au/api#listopenorders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the order book for |
| limit | int | No | the maximum amount of order book entries to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
coinspot.fetchOrderBook (symbol, limit?, params?)fetchTicker
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of coinspot
Returns: object - a ticker structure
See: https://www.coinspot.com.au/api#latestprices
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
coinspot.fetchTicker (symbol, params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of coinspot
Returns: object - a dictionary of ticker structures
See: https://www.coinspot.com.au/api#latestprices
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined | Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object | No | extra parameters specific to the exchange API endpoint |
coinspot.fetchTickers (symbols, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of coinspot
Returns: Array<Trade> - a list of trade structures
See: https://www.coinspot.com.au/api#orderhistory
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch trades for |
| since | int | No | timestamp in ms of the earliest trade to fetch |
| limit | int | No | the maximum amount of trades to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
coinspot.fetchTrades (symbol, since?, limit?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of coinspot
Returns: Array<Trade> - a list of trade structures
See: https://www.coinspot.com.au/api#rotransaction
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | the earliest time in ms to fetch trades for |
| limit | int | No | the maximum number of trades structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
coinspot.fetchMyTrades (symbol, since?, limit?, params?)createOrder
create a trade order
Kind: instance method of coinspot
Returns: object - an order structure
See: https://www.coinspot.com.au/api#placebuyorder
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| type | string | Yes | must be 'limit' |
| side | string | Yes | 'buy' or 'sell' |
| amount | float | Yes | how much of currency you want to trade in units of base currency |
| price | float | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object | No | extra parameters specific to the exchange API endpoint |
coinspot.createOrder (symbol, type, side, amount, price?, params?)cancelOrder
cancels an open order
Kind: instance method of coinspot
Returns: object - An order structure
See
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | not used by coinspot cancelOrder () |
| params | object | No | extra parameters specific to the exchange API endpoint |
coinspot.cancelOrder (id, symbol, params?)