API Documentation

Crypto-ML offers API access as part of our Insider Pro Membership. With the APIs, you can access the current Bitcoin Price Predictions as well as our raw and transformed data set, covering 50+ broad financial data points. This documentation provides you with the details needed to begin integrating our APIs into your projects.

API Overview

Crypto-ML provides two services via API.

  1. Predict API: returns the current value of our 30-day Bitcoin price prediction. This is useful for integrating our predictions into your investment projects.
  2. Raw Data API: returns the current list of 50+ raw and transformed data points used by our AI models. This is useful for developing your own machine-learning models based on our broad financial data set.

Both are simple JSON format POST requests.

Request API Key

If you are an Insider Pro member and don’t yet have your access information, you may contact support to request your key. We will provide you with:

  1. Your API endpoint
  2. Your pass

If you are not yet a member and want to try our API, you may upgrade your account to Insider Pro. It includes a 30-day free trial and you may cancel at any time.

API Limits and Abuse

The data provided via these endpoints is updated once daily at 0 UTC. We recommend placing your request shortly after, such as 00:15 UTC.

While there may be cases for pulls multiple times per day, there is no need to generate ongoing high-frequency requests.

We may request you reasonably reduce your API request frequency. If an unnecessary, excessive, or abusive rate of requests persists, we may terminate your services entirely, including your endpoint and pass.

Please contact support for any questions and help with getting the proper configuration for your use case.

Predict API

The Predict API returns the current prediction from our 30-day Bitcoin price prediction model. This value is updated daily at 0 UTC.

We recommend running your scripts shortly after 0 UTC, such as 00:15 UTC.

You will be provided an endpoint and pass.

ItemDetailNotes
MethodPOST
URIhttps://api.crypto-ml.com:443/predict?api-version=2022-06-01&sp=%2&sv=1.0&sig=f2rj8GhjxRThis is a sample. You will be provided with your endpoint.
JSON Body{
    “pass”: “NGhAANRg8xPG8NAkrsNbuurt0yG4bWlO”
}
You will be provided with your pass for authorization purposes.

JSON Schema

{
  "type": "object",
  "properties": {
    "pass": {
      "type": "string"
    }
  }
}

Body payload sample

{
    "pass": "lQkHWurtwgSKshu7AVlyvbfAKIgPYRZ8"
}

Simply include the pass provided to you as part of your Insider Pro membership.

Response sample success

{
    "Date": "44927",
    "Price": "16614.2",
    "PriceSMA": "16587.2433333333",
    "Predicted": "-14.7173862883602"
}

This returns the predicted movement of Bitcoin 30 days from now. In this sample, it is predicting a drop of 14.7% from PriceSMA, which is Bitcoin’s price average of the current and prior 2 days.

See our data point definitions for full detail.

Response sample 401 unauthorized

{
    "Response": "Invalid key"
}

If you receive this response, your key may be incorrectly entered or blocked from our end. Please contact support for help.

Raw Data API

The Raw Data API returns the current list of 50+ raw and transformed data points used by our AI models. This is useful for developing your own machine-learning models based on our broad financial data set.

You can gather historical data from our Bitcoin Data for Machine Learning page and then use this API to append new daily values.

The values are updated daily at 0 UTC.

We recommend running your scripts shortly after 0 UTC, such as 00:15 UTC.

You will be provided an endpoint and pass.

ItemDetailNotes
MethodPOST
URIhttps://api.crypto-ml.com:443/raw?api-version=2022-06-01&sp=%2&sv=1.0&sig=f2rj8GhjxRThis is a sample. You will be provided with your endpoint.
JSON Body{
    “pass”: “NGhAANRg8xPG8NAkrsNbuurt0yG4bWlO”
}
You will be provided with your pass for authorization purposes.

JSON Schema

{
  "type": "object",
  "properties": {
    "pass": {
      "type": "string"
    }
  }
}

Body payload sample

{
    "pass": "lQkHWurtwgSKshu7AVlyvbfAKIgPYRZ8"
}

Simply include the pass provided to you as part of your Insider Pro membership.

Response sample success

{
    "Date": "44926",
    "xPrice": "16550.56",
    "xPriceSmooth": "16595.77",
    "x3Price": "16639.78",
    "v3Price": "-0.536184973599396",
    "x10Price": "16815.06",
    "v10Price": "-1.57299468452685",
    "x30Price": "17075.23",
    "v30Price": "-3.07269653175974",
    "x60Price": "20149.1",
    "v60Price": "-17.859557002546",
    "x90Price": "19638",
    "v90Price": "-15.7217639270801",
    "vSentiment": "26",
    "vDOM": "12",
    "vDOW": "7",
    "xBBup": "17709.7569353612",
    "xBBlow": "16440.7030646388",
    "vBBup": "0.0700397409731863",
    "vBBlow": "-0.00663765669325884",
    "vVIX": "21.67",
    "v30VIX": "12.0443008767882",
    "v13WT": "4.26",
    "v3013WT": "1.17370892018779",
    "v10YRT": "3.88",
    "v3010YRT": "9.53608247422681",
    "vYieldCrv": "-0.38",
    "v30YieldCrv": "0.32",
    "xCrude": "78.79",
    "v30Crude": "0.786901891102938",
    "xWheat": "791",
    "v30Wheat": "6.63716814159292",
    "vDX": "103.49",
    "v30DX": "-0.985602473668963",
    "xSP500": "3839.5",
    "v30SP500": "-6.04766245604896",
    "xNASD": "10466.48",
    "v30NASD": "-9.50673005633222",
    "xDow": "33147.25",
    "v30Dow": "-3.86949143594113",
    "xRussell": "1761.25",
    "v30Russell": "-7.47139815471965",
    "xGold": "1830.1",
    "v30Gold": "1.7922517895197",
    "xEURUSD": "1.07",
    "v30EURUSD": "1.86915887850467",
    "xUSDJPY": "131.11",
    "v30USDJPY": "-2.4101899168637",
    "xFTSE": "7451.74",
    "v30FTSE": "-1.40222283654556",
    "xShenzhen": "11015.99",
    "v30Shenzhen": "-1.85003799023057",
    "xNikkei": "26094.5",
    "v30Nikkei": "-6.45116787062408",
    "xEmerMar": "37.9",
    "v30EmerMar": "-4.32717678100264"
}

This returns the current raw and transformed values used by our machine-learning models. These are ready to be appended to historical data you have already utilized.

See our data point definitions for full detail.

Response sample 401 unauthorized

{
    "Response": "Invalid key"
}

If you receive this response, your key may be incorrectly entered or blocked from our end. Please contact support for help.

Ready to Get Started?

Learn more and sign up now at Insider Pro.

Leave a Comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.