p2b

p2b{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchMarkets
• fetchTickers
• fetchTicker
• fetchOrderBook
• fetchTrades
• fetchOHLCV
• fetchBalance
• createOrder
• cancelOrder
• fetchOpenOrders
• fetchOrderTrades
• fetchMyTrades
• fetchClosedOrders

fetchMarkets{docsify-ignore}

retrieves data on all markets for bigone

Kind: instance method of p2b
Returns: Array<object> - an array of objects representing market data

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#markets

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

p2b.fetchMarkets (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 p2b
Returns: object - a dictionary of ticker structures

See: https://futures-docs.poloniex.com/#get-real-time-ticker-of-all-symbols

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

p2b.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 p2b
Returns: object - a ticker structure

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#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

p2b.fetchTicker (symbol, params?)

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of p2b
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#depth-result

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 EXCHANGE SPECIFIC PARAMETERS
params.interval	string	No	0 (default), 0.00000001, 0.0000001, 0.000001, 0.00001, 0.0001, 0.001, 0.01, 0.1, 1

p2b.fetchOrderBook (symbol, limit?, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of p2b
Returns: Array<Trade> - a list of trade structures

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#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	1-100, default=50
params	object	No	extra parameters specific to the exchange API endpoint
params.lastId	int	Yes	order id

p2b.fetchTrades (symbol, since?, limit?, 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 p2b
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#kline

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to fetch OHLCV data for
timeframe	string	Yes	1m, 1h, or 1d
since	int	No	timestamp in ms of the earliest candle to fetch
limit	int	No	1-500, default=50
params	object	No	extra parameters specific to the exchange API endpoint
params.offset	int	No	default=0, with this value the last candles are returned

p2b.fetchOHLCV (symbol, timeframe, since?, limit?, 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 p2b
Returns: object - a balance structure

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#all-balances

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

p2b.fetchBalance (params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of p2b
Returns: object - an order structure

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#create-order

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	Yes	the price at which the order is to be fulfilled, in units of the quote currency
params	object	No	extra parameters specific to the exchange API endpoint

p2b.createOrder (symbol, type, side, amount, price, params?)

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of p2b
Returns: object - An order structure

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#cancel-order

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

p2b.cancelOrder (id, symbol, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of p2b
Returns: Array<Order> - a list of order structures

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#open-orders

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 EXCHANGE SPECIFIC PARAMETERS
params.offset	int	No	0-10000, default=0

p2b.fetchOpenOrders (symbol, since?, limit?, params?)

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

Kind: instance method of p2b
Returns: Array<object> - a list of trade structures

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#deals-by-order-id

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	unified market symbol
since	int	No	the earliest time in ms to fetch trades for
limit	int	No	1-100, default=50
params	object	No	extra parameters specific to the exchange API endpoint EXCHANGE SPECIFIC PARAMETERS
params.offset	int	No	0-10000, default=0

p2b.fetchOrderTrades (id, symbol, since?, limit?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user, only the transaction records in the past 3 month can be queried, the time between since and params["until"] cannot be longer than 24 hours

Kind: instance method of p2b
Returns: Array<Trade> - a list of trade structures

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#deals-history-by-market

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, default = params["until"] - 86400000
limit	int	No	1-100, default=50
params	object	No	extra parameters specific to the exchange API endpoint
params.until	int	No	the latest time in ms to fetch orders for, default = current timestamp or since + 86400000 EXCHANGE SPECIFIC PARAMETERS
params.offset	int	No	0-10000, default=0

p2b.fetchMyTrades (symbol, since?, limit?, params?)

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user, the time between since and params["untnil"] cannot be longer than 24 hours

Kind: instance method of p2b
Returns: Array<Order> - a list of order structures

See: https://github.com/P2B-team/p2b-api-docs/blob/master/api-doc.md#orders-history-by-market

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, default = params["until"] - 86400000
limit	int	No	1-100, default=50
params	object	No	extra parameters specific to the exchange API endpoint
params.until	int	No	the latest time in ms to fetch orders for, default = current timestamp or since + 86400000 EXCHANGE SPECIFIC PARAMETERS
params.offset	int	No	0-10000, default=0

p2b.fetchClosedOrders (symbol, since?, limit?, params?)