Standards and Conventions
This section represents used standards, conventions and object across all documents and API Endpoints, provided by Crypto APIs.
Endpoint Response Payload Format
All endpoints return results in JSON format and JSON/HTTPS binding for Ethereum based contracts, when the call is successfully executed.
Status object is always included for both successful calls and failures when possible. The Status object always includes the current time on the server when the call was executed as time-stamp, the number of API call credits this call utilized as credit count, and the number of milliseconds it took to process the request as elapsed. Any details about errors encountered can be found under the error_code and error_message.
Cryptocurrency, Exchanges and Fiat currency identifiers
All of the identifiers used are ISO compliant and used in accordance to the unique Crypto APIs ID.
Cryptocurrencies may be identified using their unique exchange name (ex. Bitcoin) or through their asset ID (ex. BTC). You may get a list of all active assets from Crypto APIs by calling the endpoint /v1/assets.
Exchanges supported by Crypto APIs may be identified using the unique exchange name (ex. Kraken) or through their exchange ID (ex. KRAKEN). You may get a list of all active exchange from Crypto APIs by calling the endpoint /v1/exchanges.
All of the fiat currency options use the standard ISO 8601 currency codes (ex. USD for US Dollar or EUR for Euro). Unless otherwise stated, endpoints with fiat currency options support these major currency codes:
Currency Code Currency AED United Arab Emirates Dirham ALL Albanian Lek ARY Peso ATS Authorship AUD Australian Dollar BAM Convertible Mark BEC Convertible Franc BGN Bulgarian Lev BHD Bahraini Dinar BOB Boliviano BOP Peso Boliviano BRC Cruzado BRE Cruzeiro BRL Brazilian Real BSD Bahamian Dollar BUK Burma CAD Canadian Dollar CHC WIR Franc CHF Swiss Franc CNX Peoples Bank Dollar CNY Yuan Renminbi CRC Costa Rican Colon CYP Cyprus Pound CZK Czech Koruna DEM Deutsche Mark DKK Danish Krone ESP Spanish Peseta ETB Ethiopian Birr EUR Euro GBP Pound Sterling GHS Ghana Cedi HKD Hong Kong Dollar HRK Croatian Kuna HUF Forint IDR Rupiah ILS New Israeli Sheqel INR Indian Rupee JPY Yen KRW Won LTT Talonas LUC Luxembourg Convertible Franc MAD Moroccan Dirham MTL Maltese Lira MUR Mauritius Rupee MVR Rufiyaa MXN Mexican Peso MYR Malaysian Ringgit NGN Naira NIC Cordoba NLG Netherlands Guilder NOK Norwegian Krone NZD New Zealand Dollar PEN Nuevo Sol PHP Philippine Peso PLN Zloty RON New Romanian Leu RUB Russian Ruble RUR Russian Ruble SBD Solomon Islands Dollar SDG Sudanese Pound SEK Swedish Krona SGD Singapore Dollar SLL Leone SUR Rouble SVC El Salvador Colon THB Baht TOP Top Coin TRY Turkish Lira TWD New Taiwan Dollar UAH Hryvnia USD US Dollar XAG Silver XAU Gold XBB Bond Markets Monetary Unit XBC Bond Markets Unit of Account 9 XPD Petro Dollar XPT Platinum XRE Revolver Coin ZAR Rand
Date and Time Formats
For all required endpoints with time stamp, input and output time values used are UNIX standard based (eg. 1540220759 or translated 10/22/2018 @ 3:05pm (UTC)). If a time-zone isn’t specified, we default to UTC. All time stamps returned in JSON payloads are returned in UTC time and can be converted here for human eye readability.
The UNIX time stamp is a way to track time as a running total of seconds. This is very useful to computer systems for tracking and sorting dated information in dynamic and distributed applications both online and client side