Skip to content

Instantly share code, notes, and snippets.

@rdaindex

rdaindex/RDA_index_API_Endpoints.md Secret

Last active November 7, 2021 11:24
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save rdaindex/68fe93e19644d83d3da76b218119b3ed to your computer and use it in GitHub Desktop.
Save rdaindex/68fe93e19644d83d3da76b218119b3ed to your computer and use it in GitHub Desktop.
Download ZIP
Raw
RDA_index_API_Endpoints.md

Introduction

The RDA Index (RDAi) APIs are organized around REST. RDA Index API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. For each API endpoint, there is an option to append "csv" in order to fetch a CSV data structure.

Errors

RDA Index Enterprise API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the2xxrange indicate success. Codes in the4xxrange indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with API servers (these are rare). Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported

How to use RDA Index

The RDA Index API provides fundamental analysis data for cryptoassets. The following data sets are available through the API:

(1) RDA IV Ranking: Asset ranking by intrinsic value
(2) RDA IV Rating: Asset ratings by investibility
(3) RDA Pricing: Asset pricing data based on their underlying intrinsic attributes
(4) RDA Exchange Rates: Intrinsic exchange rate between assets
(5) RDA 10 Index: Top 10 assets by intrinsic value, investibility, low systemic risk and sustainable returns

Subscribe to RDAi API announce mailing list for updates.

Home Page: https://www.rdaindex.com
API Docs: https://rdaindex.com/index-methodology

Calling this API

You'll need to set a request header and enter your API Key to call any endpoint in this API.

API Endpoints

  1. [GET api.rdaindex.com/enterprise/ivranking]
  2. [GET api.rdaindex.com/enterprise/ivrating]
  3. [GET api.rdaindex.com/enterprise/pricing]
  4. [GET api.rdaindex.com/enterprise/xrates]
  5. [GET api.rdaindex.com/enterprise/rdaindex]

For each endpoint, there is an option to append "csv" in order to fetch a CSV data structure.
For example: api.rdaindex.com/enterpris/ivranking/csv

GET api.rdaindex.com/enterprise/ivranking

RDA IV RANKING quantifies the instrinsic value (IV) of each cryptoasset. RDA IV Ranking uses a proprietary algorithm to analyse cryptoasset attributes and compute their intrinsic value on a 0 to N point scale, where 0 indicates no intrinsic value and N is the highest intrinsic value for a given asset. Using the RDA Methodology, this api gives you the ranking of the crypto assets based on their intrinsic value. You need to pass your api key as the value for the header X-API-KEY. This is the only requirement to fetch the data for this api endpoint.

RDA IV Ranking Request Header

Header Value
X-API-KEY {YOUR-API-KEY}

API Docs: https://rdaindex.com/index-methodology

Request Parameters {}

None

Response {}

{  [
    {
        "Methodology Version": "2.0",
        "API Title": "RDA IV Ranking",
        "Algorithm": "RDA.SLICER_v4.2",
        "ts": "2021-10-23T10:48:51.426674"
    },
    {
        "marketivlevel": 417.8969247591696,
        "marketivlevelAsset": {
            "asset": {
                "id": 2682,
                "name": "Holo",
                "type": null,
                "abbr": "HOT",
                "logo": https://...,
                "marketPrice": 0.006939516516,
                "circulatingSupply": 172895870443.36282,
                "marketCapitalisation": 1199813748.47,
                "crunchLevel": "91.83673469387756",
                "description": "Holo (HOT) is a cryptocurrency and operates on the Ethereum platform... ",
                "ivrank": 1
            },
            "id": 2682,
            "ecosystem": 122.74695047500907,
            "utility": 276.44359108355934,
            "technology": 15.650188039828889,
            "sentiments": 3.0561951607723166,
            "rda_points": 417.8969247591696
        },
        "rdai_ts": 1634985904324,
        "asset_rdaPoints": [
            {
                "asset": {
                    "id": 2682,
                    "name": "Holo",
                    "type": null,
                    "abbr": "HOT",
                    "logo": https://...,
                    "marketPrice": 0.006939516516,
                    "circulatingSupply": 172895870443.36282,
                    "marketCapitalisation": 1199813748.47,
                    "crunchLevel": "91.83673469387756",
                    "description": "Holo (HOT) is a cryptocurrency and operates on the Ethereum platform... ",
                    "ivrank": 1
                },
                "id": 2682,
                "ecosystem": 122.74695047500907,
                "utility": 276.44359108355934,
                "technology": 15.650188039828889,
                "sentiments": 3.0561951607723166,
                "rda_points": 417.8969247591696
            },
            {
                "asset": {
                    "id": 1027,
                    "name": "Ethereum",
                    "type": null,
                    "abbr": "ETH",
                    "logo": https://...,
                    "marketPrice": 2895.953508653455,
                    "circulatingSupply": 118042478.9365,
                    "marketCapitalisation": 341845531046.31,
                    "crunchLevel": "95.91836734693877",
                    "description": "Ethereum (ETH) is a cryptocurrency . Users are able to generate ETH through the process of mining... ",
                    "ivrank": 2
                },
                "id": 1027,
                "ecosystem": 117.57342724052953,
                "utility": 134.65520509599918,
                "technology": 44.30548227331482,
                "sentiments": 22.98871724566412,
                "rda_points": 319.52283185550766
            },
            {
                "asset": {
                    "id": 4705,
                    "name": "PAX Gold",
                    "type": null,
                    "abbr": "PAXG",
        ...
            },}

GET api.rdaindex.com/enterprise/ivrating

RDA IV RATING enables crypto users to determine the investibility of cryptoassets. RDA IV Rating enable crypto users and investors to identify asset integrity and systemic risks. You need to pass your api key as the value for the header X-API-KEY. This is the only requirement to fetch the data for this api endpoint.

RDA Rating Request Header

Header Value
X-API-KEY {YOUR-API-KEY}

API Docs: https://rdaindex.com/index-methodology

Request Parameters {}

None

Response{}

{ [
    {
        "Methodology Version": "2.0",
        "API Title": "RDA IV Rating",
        "Algorithm": "RDA.SLICER_v4.2",
        "ts": "2021-10-23T10:59:14.156048"
    },
    [
        {
            "id": 1027,
            "asset": {
                "id": 1027,
                "name": "Ethereum",
                "type": null,
                "abbr": "ETH",
                "logo": https://...,
                "marketPrice": 2895.953508653455,
                "circulatingSupply": 118042478.9365,
                "marketCapitalisation": 341845531046.31,
                "crunchLevel": "95.91836734693877",
                "description": "Ethereum (ETH) is a cryptocurrency . Users are able to generate ETH through the process of mining...",
                "ivrank": 2
            },
            "ivrating_score": "86.12376076854702%",
            "ivrating_stars": 4.1123760768547015,
            "ivrating_rank": 1,
            "ecosystem_score": "95.78521241101394%",
            "technology_score": "100.0%",
            "utility_score": "48.70983066317409%",
            "sentiments_score": "100.0%"
        },
        {
            "id": 2682,
            "asset": {
                "id": 2682,
                "name": "Holo",
                "type": null,
                "abbr": "HOT",
                "logo": https://...,
                "marketPrice": 0.006939516516,
                "circulatingSupply": 172895870443.36282,
                "marketCapitalisation": 1199813748.47,
                "crunchLevel": "91.83673469387756",
                "description": "Holo (HOT) is a cryptocurrency and operates on the Ethereum platform...",
                "ivrank": 1
            },
            "ivrating_score": "62.1544233732646%",
            "ivrating_stars": 2.73848077910882,
            "ivrating_rank": 2,
            "ecosystem_score": "100.0%",
            "technology_score": "35.32336685398184%",
            "utility_score": "100.0%",
            "sentiments_score": "13.294326639076578%"
        },
        {
            "id": 2010,
            "asset": {
                "id": 2010,
                "name": "Cardano",
                "type": null,
                "abbr": "ADA",
                "logo": https://...,
                "marketPrice": 1.561780440521,
                "circulatingSupply": 32899071908.17,
                "marketCapitalisation": 51381127017.47,
                "crunchLevel": "95.91836734693877",
                "description": "Cardano (ADA) is a cryptocurrency launched in 2017. Users are able to generate ADA through the process of mining...",
                "ivrank": 4
            },
            "ivrating_score": "54.54178509809559%",
            "ivrating_stars": 2.4847261699365197,
...
        }, }

GET api.rdaindex.com/enterprise/pricing

RDA PRICING shows the asset pricing based on its underlying intrinsic attributes. The RDA Price stands in contrast to the market price to reveal the impact of speculation on each asset.. You need to pass your api key as the value for the header X-API-KEY. This is the only requirement to fetch the data for this api endpoint.

RDA Pricing Request Header

Header Value
X-API-KEY {YOUR-API-KEY}

Web2 Docs: https://rdaindex.com/index-methodology

Request Parameters {}

None

Response {}

{ [
    {
        "Methodology Version": "2.0",
        "API Title": "RDA Pricing",
        "Algorithm": "RDA.SLICER_v4.2",
        "ts": "2021-10-23T11:00:07.260167"
    },
    [
        {
            "id": 2682,
            "asset": {
                "id": 2682,
               "name": "Holo",
                "type": null,
                "abbr": "HOT",
                "logo": https://...,
                "marketPrice": 0.006939516516,
                "circulatingSupply": 172895870443.36282,
                "marketCapitalisation": 1199813748.47,
                "crunchLevel": "91.83673469387756",
                "description": "Holo (HOT) is a cryptocurrency and operates on the Ethereum platform...",
                "ivrank": 1
            },
            "rda_price": 1.1058294170051186,
            "utility_price": 0.44479111742543537,
            "ecosystem_price": 0.44479111742543537,
            "technology_price": 0.1571151981421117,
            "sentiment_price": 0.05913198401213605,
            "RDAMratio": 159.35251605143935,
            "RDAMratio_rank": 1,
            "rda_marketcap": 191193339614.97644
        },
        {
            "id": 1567,
            "asset": {
                "id": 1567,
                "name": "Nano",
                "type": null,
                "abbr": "NANO",
                "logo": https://...,
                "marketPrice": 3.892111250757,
                "circulatingSupply": 133248297.197,
                "marketCapitalisation": 518617196.66,
                "crunchLevel": "95.91836734693877",
                "description": "Nano (NANO) is a cryptocurrency launched in 2015...",
                "ivrank": 41
            },
            "rda_price": 253.2383136075732,
            "utility_price": 23.61803142048083,
            "ecosystem_price": 108.01190067598493,
            "technology_price": 121.60838151110741,
            "sentiment_price": 0,
            "RDAMratio": 65.06451056822165,
            "RDAMratio_rank": 2,
            "rda_marketcap": 33743574073.249
        },
        {
            "id": 2566,
            "asset": {
                "id": 2566,
                "name": "Ontology",
                "type": null,
                "abbr": "ONT",
                "logo": https://...,
                "marketPrice": 0.695025118651,
                "circulatingSupply": 875249524,
                "marketCapitalisation": 608320404.27,
                "crunchLevel": "95.91836734693877",
                "description": "Ontology (ONT) is a cryptocurrency launched in 2017...",
                "ivrank": 28
            },
            "rda_price": 42.42132334502333,
            "utility_price": 3.4859934618227095,
            "ecosystem_price": 20.315291454756608,
            "technology_price": 18.620038428444015,
            "sentiment_price": 0,
            "RDAMratio": 61.035669368843024,
            "RDAMratio_rank": 3,
            "rda_marketcap": 37129243065.18176
        }, }

GET api.rdaindex.com/enterprise/xrates

The RDA Exchange Rate data clarifies the intrinsic exchange rates between cryptoassets based on their underlying attributes. RDA Exchange Rates offers unlimited opportunites to identify the most rewarding trade pair that will maximise the fundamental value of a portfolio. You need to pass your api key as the value for the header X-API-KEY. This is the only requirement to fetch the data for this api endpoint.

RDA xrates Request Header

Header Value
X-API-KEY {YOUR-API-KEY}

API Docs: https://rdaindex.com/index-methodology

Request Parameters {}

None

Response {}

{...}

GET api.rdaindex.com/enterprise/rdaindex

RDA 10 Index provides an investible portfolio of the top 10 assets by intrinsic value, investibility, low systemic risk and sustainable returns. The construction of RDA 10 Index Portfolio is guided by the belief that low risk and sustainable returns are driven by intrinsic value. The RDA 10 Index Portfolio is useful for investors guided by clear principles that fundamentals factors drive sustainable market performance. You need to pass your api key as the value for the header X-API-KEY. This is the only requirement to fetch the data for this api endpoint.

RDA rda 10 index Request Header

Header Value
X-API-KEY {YOUR-API-KEY}

API Docs: https://rdaindex.com/index-methodology

Request Parameters {}

None

Response {}

{ [
    {
        "Methodology Version": "2.0",
        "API Title": "RDA Tradeable Index",
        "Algorithm": "RDA.SLICER_v4.2",
        "ts": "2021-10-23T11:00:56.573183"
    },
    {
        "ts": 1634986800000,
        "serial": 957,
        "year": 2021,
        "date": "20211023",
        "rda_level": 1.0413816491060166,
        "constituents": [
            {
                "id": 2682,
                "name": "Holo",
                "abbr": "HOT",
                "logo": https://...,
                "marketPrice": 0.006924729472,
                "marketCapitalisation": 1197257129.59,
                "weight": 0.3058024559793466,
                "rda_points": 417.8914881413085,
                "RDAMratio": 159.69071935891398,
                "return_percentage": -0.0021308464308582575,
                "ti_value": 0.31766670862708396,
                "ivrating_stars": 2.7387624263066326
            },
...
            {
                "id": 1274,
                "name": "Waves",
                "abbr": "WAVES",
                "logo": https://...,
                "marketPrice": 20.409505633971,
                "marketCapitalisation": 2173667414.86,
                "weight": 0.04749014035092335,
                "rda_points": 117.82343295247775,
                "RDAMratio": 24.799456403342067,
                "return_percentage": -0.0041023806124041995,
                "ti_value": 0.0357519289287727,
                "ivrating_stars": 1.4279012536112559
            },
            {
                "id": 4847,
                "name": "Stacks",
                "abbr": "STX",
                "logo": https://...,
                "marketPrice": 1.561556480476,
                "marketCapitalisation": 1999250767.64,
                "weight": 0.03350584547765407,
                "rda_points": 76.45800766588272,
                "RDAMratio": 17.496826668444292,
                "return_percentage": -0.003910416504698477,
                "ti_value": 0.031131464637156197,
                "ivrating_stars": 1.0472425457797674
            }
        ],
        "allTimeLow": 0.6653,
        "allTimeHigh": 1.504
    } }
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment