API Documentation

Aidos Market REST API Documentation

Welcome to the Aidos Market REST API documentation. This API (Application Programming Interface) will allow you to access the functionality of this exchange by means of HTTP requests, making integration with your own applications possible.

Connecting to the API

You can access the API at the following url:

https://aidosmarket.com/api

You are permited to make up to 60 requests a minute.

Usage

In order to use a public API method, you must make an HTTP request to the appropriate endpoint for that particular method, sending the appropriate GET or POST parameters for that method. You can also send them in the PAYLOAD of the request in JSON format.

Here are a few basic usage examples:

# Example request using CURL on the command line
curl "https://aidosmarket.com/api/transactions" \
-d currency="ISK" \
-d limit=5	
// Example valid response
{"transactions": {
	"0":{"id":"131","date":"2014-11-13 10:42:46","aur":"1.00000000","maker_type":"buy","price":"10.00","amount":"10.00","currency":"ISK"},
	"1":{"id":"129","date":"2014-11-11 11:14:12","aur":"0.50000000","maker_type":"buy","price":"11.27","amount":"5.63","currency":"ISK"},
	"2":{"id":"128","date":"2014-11-11 11:13:49","aur":"0.50000000","maker_type":"buy","price":"10.91","amount":"5.46","currency":"ISK"},
	"3":{"id":"127","date":"2014-11-10 18:29:15","aur":"0.50000000","maker_type":"buy","price":"11.20","amount":"5.60","currency":"ISK"},
	"4":{"id":"126","date":"2014-11-10 18:25:21","aur":"0.50000000","maker_type":"buy","price":"11.20","amount":"5.60","currency":"ISK"},
	"request_currency":"ISK"
	}
}
// Example error response
{"errors":[{"message":"Invalid currency.","code":"INVALID_CURRENCY"}]}

 

Public API Methods

These methods can be accessed without an account or API key.

Stats

Returns statistics about the current state of the exchange.

GET https://aidosmarket.com/api/stats

Parameters:

  • market (string) - Three-letter currency code. If omitted, the exchange default will be returned. Must be a market supported by the exchange.
  • currency (string) - Three-letter currency code. If omitted, the exchange default will be returned. Must be a currency supported by the exchange. All stats returned will be in this currency unit.

Response:

  • market (string) - The cryptocurrency market that was queried.
  • currency (string) - The currency in which this information is presented.
  • bid (float) - Current bid price.
  • ask (float) - Current ask price.
  • last_price (float) - The price of the last transaction.
  • last_transaction_type (string) - The action performed by the taker (initiator) of the last transaction. Can be "BUY" or "SELL".
  • last_transaction_currency (string) - Three-letter currency code for the currency in which the last transaction took place.
  • daily_change (float) - The amount that the current price has fallen or risen from the last close.
  • daily_change_percent (float) - The percentage of the current price versus the last close.
  • max (float) - Today's maximum transaction price.
  • min (float) - Today's minimum transaction price.
  • open (float) - Today's open price (note: since the market is always open, it is also yesterday's close price).
  • global_units (int) - Total units in existance for the specified cryptocurrency worldwide.
  • market_cap (int) - The global market cap for the specified cryptocurrency.
  • global_volume (int) - Global trade volume for the specified cryptocurrency.
  • 24h_volume (float) - The exchange's 24 hour volume.
  • 24h_volume_buy (float) - The exchange's 24 hour buy volume.
  • 24h_volume_sell (float) - The exchange's 24 hour sell volume.
  • 1h_volume (float) - The exchange's one hour volume.
  • 1h_volume_buy (float) - The exchange's one hour buy volume.
  • 1h_volume_sell (float) - The exchange's one hour sell volume.

Historical Prices

Gives daily market close prices for the selected period.

GET https://aidosmarket.com/api/historical-prices

Parameters:

  • market (string) - Three-letter currency code. If omitted, will return the exchange default. Must be a market supported by the exchange.
  • currency (string) - Three-letter currency code. If omitted, will return the exchange default. Must be a currency supported by the exchange.
  • timeframe (string) - The timeframe for your request. Permitted values are "1mon", "3mon", "6mon", "1year" and "ytd". Default is "1mon".

Response:

  • market(string) - The currency code of the selected market.
  • currency (string) - The currency in which this information is presented.
  • date (string) - The date string in YYYY-MM-DD format.
  • price (float) - The closing price for the given date.

Order Book

Returns information on all the orders currently in the order book. Return will be grouped into two different arrays for bid and ask respectively.

GET https://aidosmarket.com/api/order-book

Parameters:

  • market (string) - Three-letter currency code. If omitted, will return the exchange default. Must be a market supported by the exchange.
  • currency (string) - Three-letter currency code. Will return the exchange default if omitted. Must be a currency supported by the exchange.

Response:

  • market(string) - The currency code of the selected market.
  • currency (string) - The currency code for the selected currency.
  • price (float) - The limit price of the order.
  • order_amount (float) - The remaining amount in BTC.
  • order_value (float) - The remaining value of the order in your requested currency.
  • converted_from (string) - The original currency in which the order was placed, if not equal to the requested currency.

Transactions

Get the latest transactions that ocurred in the exchange, ordered by date in descending order.

GET https://aidosmarket.com/api/transactions

Parameters:

  • market (string) - Three-letter currency code. Please note: You can omit this parameter to receive all trades from all markets!
  • currency (string) - Three-letter currency code. Please note: You can omit this parameter to receive all prices will be in their native currency!
  • limit (int) - The amount of records to receive. Default is 10.

Response:

  • market(string) - The currency code of the selected market.
  • currency (string)The currency in which this information is presented. Will return 'ORIGINAL' if amounts are in the original currency
  • id (int) - A unique identifier for the transaction.
  • date (string) - The date string in YYYY-MM-DD format.
  • btc (float) - The transaction amount in BTC.
  • price (float) - The price at which the transaction ocurred. Will be returned in the original currency if no currency parameter is sent in the request.
  • price1 (float)Only if no currency param sent - The price at which the transaction ocurred for the second party (maker), in the original currency.
  • amount (float) - The transction amount in the requested currency. Will be returned in the original currency if no currency parameter is sent in the request.
  • amount1 (float)Only if no currency param sent - The transaction amount in the second party's (maker's) original currency.
  • currency (string) - The currency in which the transaction ocurred. Will be returned in the original currency if no currency parameter is sent in the request.
  • currency1 (string)Only if no currency param sent - The second party's (maker's) original currency.