-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
probit
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
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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)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?)(If the page is not being rendered for you, you can refer to the mirror at https://docs.ccxt.com/)
- Install
- Examples
- Manual
- CCXT Pro
- Contributing
- Supported Exchanges
- Exchanges By Country
- API Spec By Method
- FAQ
- Changelog
- Awesome
- API Spec by Exchange
- fetchCurrencies
- alpaca
- apex
- ascendex
- aster
- backpack
- bigone
- binance
- bingx
- bit2c
- bitbank
- bitbns
- bitfinex
- bitflyer
- bitget
- bithumb
- bitmart
- bitmex
- bitopro
- bitrue
- bitso
- bitstamp
- bitteam
- bittrade
- bitvavo
- blockchaincom
- blofin
- btcbox
- btcmarkets
- btcturk
- bullish
- bybit
- bydfi
- cex
- coinbase
- coinbaseexchange
- coinbaseinternational
- coincheck
- coinex
- coinmate
- coinmetro
- coinone
- coinsph
- coinspot
- cryptocom
- cryptomus
- deepcoin
- delta
- deribit
- derive
- digifinex
- dydx
- exmo
- extended
- foxbit
- gate
- gemini
- grvt
- hashkey
- hibachi
- hitbtc
- hollaex
- htx
- hyperliquid
- independentreserve
- indodax
- kraken
- krakenfutures
- kucoin
- fetchBidsAsks
- latoken
- lbank
- lighter
- luno
- mercado
- mexc
- modetrade
- ndax
- novadax
- okx
- onetrading
- p2b
- pacifica
- paradex
- paymium
- phemex
- poloniex
- tokocrypto
- toobit
- upbit
- weex
- whitebit
- woo
- woofipro
- xt
- zaif
- fetchStatus