24 KiB
probit{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchCurrencies
- fetchBalance
- fetchOrderBook
- fetchTickers
- fetchTicker
- fetchMyTrades
- fetchTrades
- fetchTime
- fetchOHLCV
- fetchOpenOrders
- fetchClosedOrders
- fetchOrder
- createOrder
- cancelOrder
- fetchDepositAddress
- fetchDepositAddresses
- withdraw
- fetchDeposits
- fetchWithdrawals
- fetchDepositsWithdrawals
- fetchDepositWithdrawFees
- signIn
- watchBalance
- watchTicker
- watchTrades
- watchMyTrades
- watchOrders
- watchOrderBook
fetchMarkets{docsify-ignore}
retrieves data on all markets for probit
Kind: instance method of probit
Returns: Array<object> - an array of objects representing market data
See: https://docs-en.probit.com/reference/market
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchMarkets ([params])
fetchCurrencies{docsify-ignore}
fetches all available currencies on an exchange
Kind: instance method of probit
Returns: object - an associative dictionary of currencies
See: https://docs-en.probit.com/reference/currency
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchCurrencies ([params])
fetchBalance{docsify-ignore}
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of probit
Returns: object - a balance structure
See: https://docs-en.probit.com/reference/balance
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchBalance ([params])
fetchOrderBook{docsify-ignore}
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of probit
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs-en.probit.com/reference/order_book
| 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 |
probit.fetchOrderBook (symbol[, limit, params])
fetchTickers{docsify-ignore}
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of probit
Returns: object - a dictionary of ticker structures
See: https://docs-en.probit.com/reference/ticker
| 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 |
probit.fetchTickers (symbols[, params])
fetchTicker{docsify-ignore}
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of probit
Returns: object - a ticker structure
See: https://docs-en.probit.com/reference/ticker
| 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 |
probit.fetchTicker (symbol[, params])
fetchMyTrades{docsify-ignore}
fetch all trades made by the user
Kind: instance method of probit
Returns: Array<Trade> - a list of trade structures
See: https://docs-en.probit.com/reference/trade
| 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 |
probit.fetchMyTrades (symbol[, since, limit, params])
fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of probit
Returns: Array<Trade> - a list of trade structures
See: https://docs-en.probit.com/reference/trade-1
| 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 |
probit.fetchTrades (symbol[, since, limit, params])
fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of probit
Returns: int - the current integer timestamp in milliseconds from the exchange server
See: https://docs-en.probit.com/reference/time
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchTime ([params])
fetchOHLCV{docsify-ignore}
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of probit
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs-en.probit.com/reference/candle
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
Yes | the length of time each candle represents |
| since | int |
No | timestamp in ms of the earliest candle to fetch |
| limit | int |
No | the maximum amount of candles to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | string |
No | timestamp in ms of the earliest candle to fetch |
probit.fetchOHLCV (symbol, timeframe[, since, limit, params])
fetchOpenOrders{docsify-ignore}
fetch all unfilled currently open orders
Kind: instance method of probit
Returns: Array<Order> - a list of order structures
See: https://docs-en.probit.com/reference/open_order-1
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| since | int |
No | the earliest time in ms to fetch open orders for |
| limit | int |
No | the maximum number of open orders structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchOpenOrders (symbol[, since, limit, params])
fetchClosedOrders{docsify-ignore}
fetches information on multiple closed orders made by the user
Kind: instance method of probit
Returns: Array<Order> - a list of order structures
See: https://docs-en.probit.com/reference/order
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchClosedOrders (symbol[, since, limit, params])
fetchOrder{docsify-ignore}
fetches information on an order made by the user
Kind: instance method of probit
Returns: object - An order structure
See: https://docs-en.probit.com/reference/order-3
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | the order id |
| symbol | string |
Yes | unified symbol of the market the order was made in |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchOrder (id, symbol[, params])
createOrder{docsify-ignore}
create a trade order
Kind: instance method of probit
Returns: object - an order structure
See: https://docs-en.probit.com/reference/order-1
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to create an order in |
| type | string |
Yes | 'market' or 'limit' |
| side | string |
Yes | 'buy' or 'sell' |
| amount | float |
Yes | how much you want to trade in units of the 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 |
| params.cost | float |
No | the quote quantity that can be used as an alternative for the amount for market buy orders |
probit.createOrder (symbol, type, side, amount[, price, params])
cancelOrder{docsify-ignore}
cancels an open order
Kind: instance method of probit
Returns: object - An order structure
See: https://docs-en.probit.com/reference/order-2
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | unified symbol of the market the order was made in |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.cancelOrder (id, symbol[, params])
fetchDepositAddress{docsify-ignore}
fetch the deposit address for a currency associated with this account
Kind: instance method of probit
Returns: object - an address structure
See: https://docs-en.probit.com/reference/deposit_address
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchDepositAddress (code[, params])
fetchDepositAddresses{docsify-ignore}
fetch deposit addresses for multiple currencies and chain types
Kind: instance method of probit
Returns: object - a list of address structures
See: https://docs-en.probit.com/reference/deposit_address
| Param | Type | Required | Description |
|---|---|---|---|
| codes | Array<string>, undefined |
Yes | list of unified currency codes, default is undefined |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchDepositAddresses (codes[, params])
withdraw{docsify-ignore}
make a withdrawal
Kind: instance method of probit
Returns: object - a transaction structure
See: https://docs-en.probit.com/reference/withdrawal
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| amount | float |
Yes | the amount to withdraw |
| address | string |
Yes | the address to withdraw to |
| tag | string |
Yes | |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.withdraw (code, amount, address, tag[, params])
fetchDeposits{docsify-ignore}
fetch all deposits made to an account
Kind: instance method of probit
Returns: Array<object> - a list of transaction structures
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch deposits for |
| limit | int |
No | the maximum number of transaction structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchDeposits (code[, since, limit, params])
fetchWithdrawals{docsify-ignore}
fetch all withdrawals made to an account
Kind: instance method of probit
Returns: Array<object> - a list of transaction structures
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch withdrawals for |
| limit | int |
No | the maximum number of transaction structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchWithdrawals (code[, since, limit, params])
fetchDepositsWithdrawals{docsify-ignore}
fetch history of deposits and withdrawals
Kind: instance method of probit
Returns: Array<object> - a list of transaction structures
See: https://docs-en.probit.com/reference/transferpayment
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch transactions for |
| limit | int |
No | the maximum number of transaction structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | int |
No | the latest time in ms to fetch transactions for |
probit.fetchDepositsWithdrawals (code[, since, limit, params])
fetchDepositWithdrawFees{docsify-ignore}
fetch deposit and withdraw fees
Kind: instance method of probit
Returns: Array<object> - a list of fees structures
See: https://docs-en.probit.com/reference/currency
| Param | Type | Required | Description |
|---|---|---|---|
| codes | Array<string>, undefined |
Yes | list of unified currency codes |
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.fetchDepositWithdrawFees (codes[, params])
signIn{docsify-ignore}
sign in, must be called prior to using other authenticated methods
Kind: instance method of probit
Returns: response from exchange
See: https://docs-en.probit.com/reference/token
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.signIn ([params])
watchBalance{docsify-ignore}
watch balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of probit
Returns: object - a balance structure
See: https://docs-en.probit.com/reference/balance-1
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
probit.watchBalance ([params])
watchTicker{docsify-ignore}
watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of probit
Returns: object - a ticker structure
See: https://docs-en.probit.com/reference/marketdata
| 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 |
| params.interval | int |
No | Unit time to synchronize market information (ms). Available units: 100, 500 |
probit.watchTicker (symbol[, params])
watchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of probit
Returns: Array<object> - a list of trade structures
See: https://docs-en.probit.com/reference/trade_history
| 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 |
| params.interval | int |
No | Unit time to synchronize market information (ms). Available units: 100, 500 |
probit.watchTrades (symbol[, since, limit, params])
watchMyTrades{docsify-ignore}
get the list of trades associated with the user
Kind: instance method of probit
Returns: Array<object> - a list of trade structures
See: https://docs-en.probit.com/reference/trade_history
| 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 |
probit.watchMyTrades (symbol[, since, limit, params])
watchOrders{docsify-ignore}
watches information on an order made by the user
Kind: instance method of probit
Returns: object - An order structure
See: https://docs-en.probit.com/reference/open_order
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market the order was made in |
| since | int |
No | timestamp in ms of the earliest order to watch |
| limit | int |
No | the maximum amount of orders to watch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.channel | string |
No | choose what channel to use. Can open_order or order_history. |
probit.watchOrders (symbol[, since, limit, params])
watchOrderBook{docsify-ignore}
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of probit
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs-en.probit.com/reference/marketdata
| 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 |
probit.watchOrderBook (symbol[, limit, params])