NAV Navbar
shell python javascript

Introduction

Welcome to the Nordic Crypto API! You can use our API to access Nordic Crypto API endpoints, which can get information on various signals, crash alerts, and trade recommendation.

We have language bindings in Shell, Python, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To authorize, use this code when you request an api endpoint:

  import requests
  headers = {"Authorization" : "meowmeowmeow"}
  r = requests.get('https://api_endpoint_here', headers=headers)
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: meowmeowmeow"
TBD

Make sure to replace meowmeowmeow with your API key.

Nordic Crypto uses API keys to allow access to the API. You can register a new Nordic Crypto API key by logging into our platform.

Nordic Crypto expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: meowmeowmeow

Coins

Get Coins

import requests
r = requests.get('https://app.nordiccrypto.com/api/v1.0/coins', headers={'Authorization':'meowmeowmeow'})
print(r.json())

curl "https://app.nordiccrypto.com/api/v1.0/coins"
  -H "Authorization: meowmeowmeow"
TBD

The above command returns JSON structured like this:

[
  {
    "rank": 1, 
    "url_name": "bitcoin", 
    "coin_name": "Bitcoin", 
    "pair": "USD_BTC", 
    "usd_volume": 3445190000.0, 
    "volume": 3445190000.0, 
    "direction": "SHORT", 
    "days_long": 0,
    "days_short" : 18
  }

]

This endpoint retrieves all coins supported.

HTTP Request

GET https://app.nordiccrypto.com/api/v1.0/coins

Query Parameters

Parameter Default Description
market USD Use BTC to get all BTC_XXX. Supported markets are: BTC, USDT, USD, ETH
pair None Set pair. E.g. USD_BTC

Alpha 1 Signals

Get Signals

import requests
r = requests.get('https://app.nordiccrypto.com/api/v1.0/alpha1/signals', headers={'Authorization':'meowmeowmeow'})
print(r.json())

curl "https://app.nordiccrypto.com/api/v1.0/alpha1/signals"
  -H "Authorization: meowmeowmeow"
TBD

The above command returns JSON structured like this:

[
    {
        "coin_name": "Bitcoin",
        "buy_or_sell": "SELL",
        "ticker": "BTC",
        "market": "USD",
        "entry_date": "2018-07-17 00:00:00",
        "entry": 7321.04,
        "exit_date": "2018-08-04 00:00:00",
        "exit": 7032.85,
        "pnl": -0.0394,
        "is_open": false,
        "signal": "LONG",
        "exchange": "Aggregated",
        "message": ""
    },
    {
        "coin_name": "Bitcoin",
        "buy_or_sell": "BUY",
        "ticker": "BTC",
        "market": "USD",
        "entry_date": "2018-07-17 00:00:00",
        "entry": 7321.04,
        "closed_date": "2018-08-04 00:00:00",
        "exit": 7032.85,
        "is_open": false,
        "signal": "LONG",
        "exchange": "Aggregated",
        "message": ""
    }

]

This endpoint retrieves all signals from subscribed instruments. You can poll this every minute for testing purposes, although this is a daily signal.

HTTP Request

GET https://app.nordiccrypto.com/api/v1.0/alpha1/signals

Query Parameters

Parameter Default Description
market USD Options are XXX = ETH, USDT, BTC for XXX_YYY where Y = coin tickers.
ticker None Specify a coin ticker to get crash alert from. E.g. BTC
start datetime E.g. 2018-10-31
end datetime E.g. 2018-12-24
exchange Aggregated E.g. "Bitmart" to get the subset of coins that are on the Bitmart exchange

Get a alpha1 pair stats

import requests

r = requests.get('https://app.nordiccrypto.com/api/v1.0/alpha1/get_stats', headers={'Authorization':'meowmeowmeow'})
print(r.json())
curl "https://app.nordiccrypto.com/api/v1.0/alpha1/get_stats"
  -H "Authorization: meowmeowmeow"
TBD

The above command returns JSON structured like this:

[
    {
        "Signal": "LONG",
        "ticker": "BTC",
        "market": "USD",
        "pnl": 1.412,
        "avg_loss": -0.0073,
        "avg_win": 0.0128,
        "max_dd": 0.0,
        "winner_ratio": 1.0,
        "risk2reward": 0.02,
        "total_trades": 255
    }
]

This endpoint retrieves stats from the alpha2 backtest.

HTTP Request

GET https://app.nordiccrypto.com/api/v1.0/alpha1/get_stats

URL Parameters

Parameter Default Description
market USD Options are XXX = ETH, USDT, BTC for XXX_YYY where Y = coin tickers.
ticker None Specify a coin ticker to get crash alert from. E.g. BTC
start datetime E.g. 2018-10-31
end datetime E.g. 2018-12-24

Alpha 2 Signals

Get Signals

import requests
r = requests.get('https://app.nordiccrypto.com/api/v1.0/alpha2/signals', headers={'Authorization':'meowmeowmeow'})
print(r.json())

curl "https://app.nordiccrypto.com/api/v1.0/alpha2/signals"
  -H "Authorization: meowmeowmeow"
TBD

The above command returns JSON structured like this:

[
    {
        "coin_name": "Bitcoin",
        "buy_or_sell": "SELL",
        "ticker": "BTC",
        "market": "USD",
        "entry_date": "2018-07-17 00:00:00",
        "entry": 7321.04,
        "exit_date": "2018-08-04 00:00:00",
        "exit": 7032.85,
        "pnl": -0.0394,
        "is_open": false,
        "signal": "LONG",
        "exchange": "Aggregated",
        "message": ""
    },
    {
        "coin_name": "Bitcoin",
        "buy_or_sell": "BUY",
        "ticker": "BTC",
        "market": "USD",
        "entry_date": "2018-07-17 00:00:00",
        "entry": 7321.04,
        "closed_date": "2018-08-04 00:00:00",
        "exit": 7032.85,
        "is_open": false,
        "signal": "LONG",
        "exchange": "Aggregated",
        "message": ""
    }

]

This endpoint retrieves all signals from subscribed instruments. You can poll this every minute for testing purposes, although this is a daily signal.

HTTP Request

GET https://app.nordiccrypto.com/api/alpha2/v1.0/signals

Query Parameters

Parameter Default Description
market USD Options are XXX = ETH, USDT, BTC for XXX_YYY where Y = coin tickers.
ticker None Specify a coin ticker to get crash alert from. E.g. BTC
start datetime E.g. 2018-10-31
end datetime E.g. 2018-12-24
exchange Aggregated E.g. "Bitmart" to get the subset of coins that are on the Bitmart exchange

Get a alpha2 pair stats

import requests

r = requests.get('https://app.nordiccrypto.com/api/v1.0/alpha2/get_stats', headers={'Authorization':'meowmeowmeow'})
print(r.json())
curl "https://app.nordiccrypto.com/api/v1.0/alpha2/get_stats"
  -H "Authorization: meowmeowmeow"
TBD

The above command returns JSON structured like this:

[
    {
        "Signal": "LONG",
        "ticker": "BTC",
        "market": "USD",
        "pnl": 1.412,
        "avg_loss": -0.0073,
        "avg_win": 0.0128,
        "max_dd": 0.0,
        "winner_ratio": 1.0,
        "risk2reward": 0.02,
        "total_trades": 255
    }
]

This endpoint retrieves stats from the alpha2 backtest.

HTTP Request

GET https://app.nordiccrypto.com/api/v1.0/alpha2/get_stats

URL Parameters

Parameter Default Description
market USD Options are XXX = ETH, USDT, BTC for XXX_YYY where Y = coin tickers.
ticker None Specify a coin ticker to get crash alert from. E.g. BTC
start datetime E.g. 2018-10-31
end datetime E.g. 2018-12-24

Alpha 3 Trades

Get a trade recommendation.

import requests

r = requests.get('https://app.nordiccrypto.com/api/v1.0/alpha3/get_trades', headers={'Authorization':'meowmeowmeow'})
print(r.json())
curl "https://app.nordiccrypto.com/api/alpha3/v1.0/get_trades"
  -H "Authorization: meowmeowmeow"
TBD

The above command returns JSON structured like this:

[
    {
        "coin_name": "Dash",
        "buy_or_sell": "BUY",
        "ticker": "DASH",
        "market": "USD",
        "entry_date": "2018-12-09 19:00:00",
        "entry": 75.51,
        "target": 78.921,
        "stop": 69.74,
        "signal": "LONG",
        "exchange": "Aggregated",
        "message": "'Dash' had a signal to buy at: 75.51, with a target exit of: 78.921 and a stop loss of 69.74"
    },
    {
        "coin_name": "Ethereum",
        "buy_or_sell": "BUY",
        "ticker": "ETH",
        "market": "USD",
        "entry_date": "2018-12-09 19:00:00",
        "entry": 97.91,
        "target": 102.112,
        "stop": 91.03,
        "signal": "LONG",
        "exchange": "Aggregated",
        "message": "'Ethereum' had a signal to buy at: 97.91, with a target exit of: 102.112 and a stop loss of 91.03"
    },
]

This endpoint retrieves all trade recommendations currently open.

HTTP Request

GET https://app.nordiccrypto.com/api/v1.0/alpha3/get_trades

URL Parameters

Parameter Default Description
market USD Options are XXX = ETH, USDT, BTC for XXX_YYY where Y = coin tickers.
ticker None Specify a coin ticker to get crash alert from. E.g. BTC
start datetime E.g. 2018-10-31
end datetime E.g. 2018-12-24

Get a alpha3 pair stats

import requests

r = requests.get('https://app.nordiccrypto.com/api/v1.0/alpha3/get_stats', headers={'Authorization':'meowmeowmeow'})
print(r.json())
curl "https://app.nordiccrypto.com/api/v1.0/alpha3/get_stats"
  -H "Authorization: meowmeowmeow"
TBD

The above command returns JSON structured like this:

[
    {
        "Signal": "LONG",
        "ticker": "BTC",
        "market": "USD",
        "pnl": 1.412,
        "avg_loss": -0.0073,
        "avg_win": 0.0128,
        "max_dd": 0.0,
        "winner_ratio": 1.0,
        "risk2reward": 0.02,
        "total_trades": 255
    }
]

This endpoint retrieves stats from the alpha3 backtest.

HTTP Request

GET https://app.nordiccrypto.com/api/v1.0/alpha3/get_stats

URL Parameters

Parameter Default Description
market USD Options are XXX = ETH, USDT, BTC for XXX_YYY where Y = coin tickers.
ticker None Specify a coin ticker to get crash alert from. E.g. BTC
start datetime E.g. 2018-10-31
end datetime E.g. 2018-12-24

Crash Alert

Get crash alerts

import requests
r = requests.get('https://app.nordiccrypto.com/api/v1.0/crashalert', headers={'Authorization':'meowmeowmeow'})
print(r.json())
curl "https://app.nordiccrypto.com/api/v1.0/crashalert"
  -H "Authorization: meowmeowmeow"
TBD

The above command returns JSON structured like this:

  [
    {
        "coin": "bitcoin",
        "ticker": "BTC",
        "market": "USD",
        "crash_alert": "2018-09-05",
        "open": 7369.89,
        "high": 7401.43,
        "low": 6884.79,
        "close": 6898.1,
        "volumeto": 711989568,
        "market_cap": 117185657641
    },
    {
        "coin": "bitcoin",
        "ticker": "BTC",
        "market": "USD",
        "crash_alert": "2017-09-08",
        "open": 4605.16,
        "high": 4661.0,
        "low": 4075.18,
        "close": 4228.75,
        "volumeto": 2700890000,
        "market_cap": 69999555938
    }
  ]

This endpoint retrieves all crash alerts on coins subscribed.

HTTP Request

GET https://app.nordiccrypto.com/api/v1.0/crashalert

URL Parameters

Parameter Default Description
market USD Options are XXX = ETH, USDT, BTC for XXX_YYY where Y = coin tickers.
ticker None Specify a coin ticker to get crash alert from. E.g. BTC
start datetime E.g. 2018-10-31
end datetime E.g. 2018-12-24

Errors

The Kittn API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The resource requested is hidden for administrators only.
404 Not Found -- The specified resource could not be found.
405 Method Not Allowed -- You tried to access a resource with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The resource requested has been removed from our servers.
429 Too Many Requests -- You're requesting too many resources! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.