Skip to content

alp

Jump to bottom
github-actions[bot] edited this page Jun 11, 2026 · 2 revisions

alp{docsify-ignore}

Kind: global class
Extends: Exchange

fetchMarkets{docsify-ignore}

retrieves data on all markets for alp

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

See: https://alpcomdev.github.io/alp-api-docs/#list-all-currencies

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
alp.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 alp
Returns: object - a dictionary of ticker structures

See: https://alpcomdev.github.io/alp-api-docs/#tickers

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

See: https://alpcomdev.github.io/alp-api-docs/#tickers

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

See: https://alpcomdev.github.io/alp-api-docs/#get-orderbook

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 
alp.fetchOrderBook (symbol, limit?, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://alpcomdev.github.io/alp-api-docs/#list-all-exchanges

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 
alp.fetchTrades (symbol, since?, limit?, params?)

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of alp
Returns: Array<object> - a list of transaction structures

See: https://alpcomdev.github.io/alp-api-docs/#list-own-deposits

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 deposits structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
alp.fetchDeposits (code, since?, limit?, params?)

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of alp
Returns: Array<object> - a list of transaction structures

See: https://alpcomdev.github.io/alp-api-docs/#list-own-made-withdraws

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 withdrawals structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
alp.fetchWithdrawals (code, 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 alp
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://alpcomdev.github.io/alp-api-docs/#charts

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 
alp.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 alp
Returns: object - a balance structure

See: https://alpcomdev.github.io/alp-api-docs/#list-own-wallets

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
alp.fetchBalance (params?)

createOrder{docsify-ignore}

create a trade order

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

See: https://alpcomdev.github.io/alp-api-docs/#create-order

Param Type Required Description
symbol string Yes unified symbol of the market to create an order in
type string Yes '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 
alp.createOrder (symbol, type, side, amount, price?, params?)

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://alpcomdev.github.io/alp-api-docs/#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 
alp.cancelOrder (id, symbol, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://alpcomdev.github.io/alp-api-docs/#retrieve-single-order

Param Type Required Description
id string Yes the order id
symbol string Yes not used by alp fetchOrder
params object No extra parameters specific to the exchange API endpoint 
alp.fetchOrder (id, symbol, params?)

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://alpcomdev.github.io/alp-api-docs/#list-own-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 
alp.fetchOrders (symbol, since?, limit?, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://alpcomdev.github.io/alp-api-docs/#list-own-orders

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 
alp.fetchOpenOrders (symbol, since?, limit?, params?)

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://alpcomdev.github.io/alp-api-docs/#list-own-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 
alp.fetchClosedOrders (symbol, since?, limit?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://alpcomdev.github.io/alp-api-docs/#list-own-exchanges

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 
alp.fetchMyTrades (symbol, since?, limit?, params?)

(If the page is not being rendered for you, you can refer to the mirror at https://docs.ccxt.com/)

Clone this wiki locally