Documentation Introduction

The BitOutlook API is very simple once you understand how straightforward it is. This documentation aims at helping you to understand what all the parameters are, their variables and the different endpoints that exist.

Individual Coin Details

This API is in JSON format and can be fetched using CURL. Data is updated once every five (5) minutes.

$COIN
This should be the symbol of the coin or token you want to get data for.


$TYPE
This is where you select through the 2 possible options. stats gets the coin statistics and info gets the coin description and technology facts.

    • stats
    • info

JSON > GET https://api.bitoutlook.com/v1/details/?coin=$COIN&type=$TYPE
EXAMPLES https://api.bitoutlook.com/v1/details/?coin=btc&type=stats https://api.bitoutlook.com/v1/details/?coin=btc&type=info

Top Risers (by Volume)

This API is in JSON format and can be fetched using CURL. Data is updated once every five (5) minutes. No parameters or variables required.

JSON > GET https://api.bitoutlook.com/v1/risers/

Top Fallers (by Volume)

This API is in JSON format and can be fetched using CURL. Data is updated once every five (5) minutes. No parameters or variables required.

JSON > GET https://api.bitoutlook.com/v1/fallers/

Top Coins (by Volume)

This API is in JSON format and can be fetched using CURL. Data is updated once every five (5) minutes. No parameters or variables required.

 

JSON > GET https://api.bitoutlook.com/v1/top/

Fiat Currency Exchange Rates

This API is in JSON format and can be fetched using CURL. Data is updated once every hour. No parameters or variables required. There is no rate limit imposed on this endpoint. However this endpoint is updated once a day, we ask that you take that into consideration within your scripts.

JSON > GET https://api.bitoutlook.com/v1/currency/

Top Coins Ticker

This API endpoint is in Javascript format. Data is updated once every five (5) minutes. No parameters or variables required. There is no rate limit imposed on this endpoint.

To use, simply include the Javascript in the position where you’d like the ticker to show up on your website or app.

Usage
<script src="https://api.bitoutlook.com/v1/widget/marquee/ticker.js"></script>

Example

JS > GET https://api.bitoutlook.com/v1/widget/marquee/ticker.js

Rate Limiting

Rate limits help us to prevent floods and abuse of our API and misuse of our data. All endpoints impose a rate limit of 1x per every 30 seconds. In short, this means that you can not make more than 2 api requests per minute, per endpoint.

API Messages

API messages will help you to understand different types of errors that may occur while using the BitOutlook API.

[602] Limited to 1x every 30 seconds. This error only occurs when you reach the rateLimit of our API. Please familiarize yourself with our Rate Limits.

[603] Required parameters invalid within api query string. This means that a VARIABLE within your API URL is not valid or recognized by our API.

[604] Required parameters missing from api query string. This means that one or all VARIABLE(s) within your API URL are required, but currently missing.