paymium

paymium{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchBalance
• fetchOrderBook
• fetchTicker
• fetchTrades
• createDepositAddress
• fetchDepositAddress
• fetchDepositAddresses
• createOrder
• cancelOrder
• transfer

fetchBalance{docsify-ignore}

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of paymium
Returns: object - a balance structure

See: https://paymium.github.io/api-documentation/#tag/User/operation/get-user-info

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

paymium.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 paymium
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://paymium.github.io/api-documentation/#tag/Public-data/operation/get-market-depth

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

paymium.fetchOrderBook (symbol, limit?, 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 paymium
Returns: object - a ticker structure

See: https://paymium.github.io/api-documentation/#tag/Public-data/operation/get-latest-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

paymium.fetchTicker (symbol, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://paymium.github.io/api-documentation/#tag/Public-data/operation/get-latest-trades

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

paymium.fetchTrades (symbol, since?, limit?, params?)

createDepositAddress{docsify-ignore}

create a currency deposit address

Kind: instance method of paymium
Returns: object - an address structure

See: https://paymium.github.io/api-documentation/#tag/User/operation/create-deposit-address

Param	Type	Required	Description
code	string	Yes	unified currency code of the currency for the deposit address
params	object	No	extra parameters specific to the exchange API endpoint

paymium.createDepositAddress (code, params?)

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of paymium
Returns: object - an address structure

See: https://paymium.github.io/api-documentation/#tag/User/operation/get-deposit-address

Param	Type	Required	Description
code	string	Yes	unified currency code
params	object	No	extra parameters specific to the exchange API endpoint

paymium.fetchDepositAddress (code, params?)

fetchDepositAddresses{docsify-ignore}

fetch deposit addresses for multiple currencies and chain types

Kind: instance method of paymium
Returns: object - a list of address structures

See: https://paymium.github.io/api-documentation/#tag/User/operation/get-deposit-addresses

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

paymium.fetchDepositAddresses (codes, params?)

createOrder{docsify-ignore}

create a trade order

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

See: https://paymium.github.io/api-documentation/#tag/Order/operation/create-order

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 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

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

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://paymium.github.io/api-documentation/#tag/Order/operation/cancel-order

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	not used by paymium cancelOrder ()
params	object	No	extra parameters specific to the exchange API endpoint

paymium.cancelOrder (id, symbol, params?)

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of paymium
Returns: object - a transfer structure

See: https://paymium.github.io/api-documentation/#tag/Transfer/operation/create-email-transfer

Param	Type	Required	Description
code	string	Yes	unified currency code
amount	float	Yes	amount to transfer
fromAccount	string	Yes	account to transfer from
toAccount	string	Yes	account to transfer to
params	object	No	extra parameters specific to the exchange API endpoint

paymium.transfer (code, amount, fromAccount, toAccount, params?)