Oracles

The oracles endpoint contains dynamic data analytics for specified oracles. Currently, only chainlink oracles are tracked.

This endpoint returns available pair list for specified oracle

This endpoint returns available pair list for that oracle provider (e.g: Chainlink)

GEThttps://api.alterscope.org/data/oracle/{oracle}/pairs

Authorization

BearerAuth

Path parameters

oracle*string

Name of the Oracle protocol , e.g. "chainlink"

Response

200404505

OK

Body

application/json

protocolstring

pairsarray of string

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/oracle/{oracle}/pairs', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "protocol": "text",
  "pairs": [
    "text"
  ]
}

Sample Request

curl https://api.alterscope.org/data/oracle/chainlink/pairs -H "Authorization: Bearer <your_access_token>"

Sample Response

{
    "status": true,
    "data": {
        "protocol": "chainlink",
        "pairs": [
            "YFI-USD",
            "SXP-USD",
            "BADGER-ETH",
            "SOL-USD",
            "1INCH-USD",
            "LINK-ETH",
            "SNX-USD",
            "BCH-USD",
            "GRT-ETH",
            "PAXG-ETH",
            "TRX-USD",
            "ARB-USD",
            "STETH-USD",
            "TUSD-USD",
            "CRV-ETH",
            "ALGO-USD",
            "STETH-ETH",
            "WBTC-BTC",
            "APE-USD",
            "USDD-USD",
            "CAKE-USD",
            "QNT-USD",
            "USDC-ETH",
            "ENJ-ETH",
            "1INCH-ETH",
            "ENS-USD",
            "XMR-USD",
            "BAT-USD",
            "COMP-USD",
            "ICP-USD",
            "USDT-USD",
            "DAI-USD",
            "SNX-ETH",
            "USDT-ETH",
            "MKR-USD",
            "BTC-USD",
            "IMX-USD",
            "OGN-USD",
            "XTZ-USD",
            "KAVA-USD",
            "GRT-USD",
            "FRAX-ETH",
            "ETC-USD",
            "FRAX-USD",
            "ZEC-USD",
            "WOO-USD",
            "UMA-USD",
            "THETA-USD",
            "CHZ-USD",
            "COMP-ETH",
            "RDNT-USD",
            "AVAX-USD",
            "SLP-USD",
            "REN-ETH",
            "CRVUSD-USD",
            "FTT-USD",
            "BNB-USD",
            "BAT-ETH",
            "DOT-USD",
            "ANKR-USD",
            "ENJ-USD",
            "AXS-USD",
            "LTC-USD",
            "OMG-USD",
            "YFI-ETH",
            "FIL-USD",
            "XRP-USD",
            "FTM-USD",
            "EOS-USD",
            "KNC-USD",
            "LINK-MATIC",
            "RSR-USD",
            "DOGE-USD",
            "SUSHI-USD",
            "XCN-USD",
            "KLAY-USD",
            "AAVE-USD",
            "ADA-USD",
            "MATIC-ETH",
            "ALPHA-USD",
            "SHIB-USD",
            "WSTETH-ETH",
            "MATIC-USD",
            "CRV-USD",
            "HBAR-USD",
            "BADGER-USD",
            "STORJ-USD",
            "FTT-ETH",
            "SAND-USD",
            "MANA-USD",
            "UNI-ETH",
            "AAVE-ETH",
            "SHIB-ETH",
            "APE-ETH",
            "XLM-USD",
            "STG-USD",
            "HIGH-USD",
            "BOND-USD",
            "LDO-ETH",
            "FIL-ETH",
            "DODO-USD",
            "KNC-ETH",
            "SUSHI-ETH",
            "ETH-USD",
            "USDC-USD",
            "LINK-USD",
            "DAI-ETH",
            "PERP-ETH",
            "ETH-BTC",
            "FTM-ETH",
            "FXS-USD",
            "UNI-USD",
            "PAXG-USD",
            "TUSD-ETH",
            "BTC-ETH",
            "MKR-ETH",
            "MANA-ETH",
            "DASH-USD"
        ]
    }
}

Sample Response Description

• protocol: Oracle provider, currently only chainlink is supported.

• pairs: This is the list of the pairs. This list can be used for retrieving weekly dynamic data for that specific oracle.

Retrieves the weekly dynamic parameters tracked for specified oracle and price feed pair

This endpoint returns daily oracle analytics data of the specified oracle from the last 7 days in descending order

GEThttps://api.alterscope.org/data/oracle/{oracle}/{pair}

Authorization

BearerAuth

Path parameters

oracle*string

Name of the Oracle protocol , e.g. "chainlink"

pair*string

Name of the Pair , e.g. "ETH-USD"

Response

200404505

OK

Body

application/json

aggregate_oracleboolean

aggregation_countinteger

user_feeinteger

fee_per_observationinteger

fee_per_transmissioninteger

datasource_disclosedboolean

provider_ageinteger

data_variancenumber

downtimeinteger

service_coverageinteger

reputationstring

report_frequencynumber

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/data/oracle/{oracle}/{pair}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "aggregate_oracle": false,
  "datasource_disclosed": false,
  "data_variance": 0,
  "reputation": "text",
  "report_frequency": 0
}

Sample Request

Note: The sample request below retrieves the weekly dynamic parameters tracked for specified oracle(currently chainlink is supported) and price feed pair.

Note: To get a list of price feed pairs for specified oracle please check sample response for get available pair list for specified oracle API endpoint .

The sample request below is for QNT-USD price pair:

curl https://api.alterscope.org/data/oracle/chainlink/QNT-USD -H "Authorization: Bearer <your_access_token>"

Sample Response

Note: The sample response below is shortened for formatting purposes. The actual response should list blockchain data for a whole week.

{
    "status": true,
    "data": [
        {
            "oracle_uuid": "chainlink",
            "oracle_chain": "polygon",
            "description": "QNT-USD",
            "aggregate_oracle": true,
            "aggregation_count": 16,
            "user_fee": 0,
            "fee_per_observation": 12932,
            "fee_per_transmission": 78178,
            "datasource_disclosed": true,
            "provider_age": 0,
            "data_variance": 0.014621587963194245,
            "downtime": 0,
            "service_coverage": 0,
            "reputation": "verified",
            "token_market_cap": -1,
            "report_frequency": 0.001142857142857143,
            "timestamp": "2024-01-18T01:06:12Z"
        },
        {
            "oracle_uuid": "chainlink",
            "oracle_chain": "polygon",
            "description": "QNT-USD",
            "aggregate_oracle": true,
            "aggregation_count": 16,
            "user_fee": 0,
            "fee_per_observation": 12932,
            "fee_per_transmission": 78178,
            "datasource_disclosed": true,
            "provider_age": 0,
            "data_variance": 0.10041728266739884,
            "downtime": 0,
            "service_coverage": 0,
            "reputation": "verified",
            "token_market_cap": -1,
            "report_frequency": 0.0008571428571428571,
            "timestamp": "2024-01-17T01:03:54Z"
        },
      }

Sample Response Description

• oracle_uuid: Name of the oracle provider. E.g: Chainlink

• oracle_chain: This is the chain on which the price feed is reported. E.g: Polygon, Ethereum.

• description: This is the name of the pair. The list of available pairs can be retrieved from /data/oracle/{protocol}/pairs endpoint.

• aggregate_oracle: A boolean indicating whether the data is part of an aggregate oracle (a combined source of information).

• aggregation_count: The number of times data has been aggregated.

• user_fee: The fee charged to the user for the service.

• fee_per_observation: The fee associated with each observation.

• fee_per_transmission: The fee associated with each transmission of data.

• datasource_disclosed: A boolean indicating whether the source of the data is disclosed.

• provider_age: The age of the service provider.

• data_variance: A numerical measure representing the variance in the provided data.

• downtime: The amount of time (in some unit) the system has been inactive or unavailable.

• service_coverage: The extent or range of service coverage.

• reputation: The reputation status of the service, described as "verified."

• token_market_cap: The market capitalization of the token.

• report_frequency: The frequency at which reports are generated.

• timestamp: The timestamp indicating the date and time of the data