Skip to content

Amberdata

Jump to bottom
Trevor French edited this page Nov 30, 2023 · 19 revisions
Logo Name Code cryptotrackr Docs Exchange Docs Source Code
amberdata Amberdata amberdata 📜 🏢 /R/amberdata.R

Functions:

amberdata_api_call, amberdata_spot_exchanges, amberdata_spot_pairs, amberdata_spot_references, amberdata_market_metrics, amberdata_blockchain_metrics, amberdata_historical_exchange_volume

amberdata_api_call

  • Parameters: (url, api_key, method, query)

    • url: the url for your Amberdata API call

    • api_key: your Amberdata API key

    • method: "GET" or "POST"

    • query: your query parameters. The default value is NULL.

  • Returns: data from your Amberdata API call

  • The following example passes the API key, the request method, and the url into the function and stores the resulting data in a variable named "exchanges".

api_key <- "..."
url <- "https://web3api.io/api/v2/market/exchanges"
method <- "GET"
exchanges <- amberdata_api_call(url, api_key, method)

amberdata_spot_exchanges

  • Parameters: (api_key, exchange, pair, include_dates, time_format)

    • api_key: your Amberdata API key

    • exchange: choose a specific exchange or multiple exchanges (comma-separated) rather than all exchanges

    • pair: choose a specific pair or multiple pairs (comma-separated) rather than all pairs

    • include_dates: include a start date and an end date along with your data. Default is "false"

    • time_format: the format to return your times in. Choose from: "milliseconds", "ms", "iso", "iso8601", "hr", and "human_readable". Default is "ms".

  • Returns: a list of spot exchanges and pairs supported on Amberdata with the option of including the dates each one was supported.

  • The following example calls the function twice. The first call accepts all defaults and stores the list in a variable named "exchanges". The second call tells the function to only return results related to "gdax" where the currency pair is "1inch_btc" or "ada_usd". It also tells the function to include the dates in "hr" (human readable) format. The response is stored in a list named "gdax".

api_key <- "..."
exchanges <- amberdata_spot_exchanges(api_key)
gdax <- amberdata_spot_exchanges(api_key, "gdax", "1inch_btc,ada_usd", "true", "hr")

amberdata_spot_pairs

  • Parameters: (api_key, exchange, pair, include_dates, time_format)

    • api_key: your Amberdata API key

    • exchange: choose a specific exchange or multiple exchanges (comma-separated) rather than all exchanges

    • pair: choose a specific pair or multiple pairs (comma-separated) rather than all pairs

    • include_dates: include a start date and an end date along with your data. Default is "false"

    • time_format: the format to return your times in. Choose from: "milliseconds", "ms", "iso", "iso8601", "hr", and "human_readable". Default is "ms".

  • Returns: a list of spot pairs and exchanges supported on Amberdata with the option of including the dates each one was supported.

  • The following example calls the function twice. The first call accepts all defaults and stores the list in a variable named "pairs". The second call tells the function to only return results related to "btc_usd". The response is stored in a list named "btc_usd".

api_key <- "..."
pairs <- amberdata_spot_pairs(api_key)
btc_usd <- amberdata_spot_pairs(api_key, pair = "btc_usd")

amberdata_spot_references

  • Parameters: (api_key, exchange, pair, include_inactive, include_original_references)

    • api_key: your Amberdata API key

    • exchange: choose a specific exchange or multiple exchanges (comma-separated) rather than all exchanges

    • pair: choose a specific pair or multiple pairs (comma-separated) rather than all pairs

    • include_inactive: If 'True', endpoint returns all pairs, including delisted ones. Default is 'False'.

    • include_original_reference: If 'True', endpoint returns originalReference. Default is 'False'.

  • Returns: a list of reference information for each of the pairs on Amberdata.

  • The following example calls the function twice. The first call accepts all defaults and stores the list in a variable named "reference". The second call tells the function to only return results related to "btc_usd". The response is stored in a list named "btc_usd".

api_key <- "..."
reference <- amberdata_spot_reference(api_key)
btc_usd <- amberdata_spot_reference(api_key, pair = "btc_usd")

amberdata_market_metrics

  • Parameters: (api_key, symbol)

    • api_key: your Amberdata API key

    • symbol: the asset symbol you wish to receive metrics for

  • Returns: a list containing market metrics for the specified symbol.

  • The following example gets the latest market metrics for BTC and stores them in a list named "metrics".

api_key <- "..."
metrics <- amberdata_market_metrics(api_key, "btc")

amberdata_blockchain_metrics

  • Parameters: (api_key, blockchain_id)

    • api_key: your Amberdata API key

    • blockchain_id: the id for the blockchain you wish to query. The default blockchain_id is "ethereum-mainnet".

  • Returns: a list containing blockchain metrics for your specified blockchain_id.

  • The following example gets the latest blockchain metrics for Ethereum Mainnet and stores them in a list named "metrics".

api_key <- "..."
metrics <- amberdata_blockchain_metrics(api_key)

amberdata_historical_exchange_volume

  • Parameters: (api_key, exchange, direction, start_date, end_date, time_format)

    • api_key: your Amberdata API key

    • exchange: the exchange you wish to retrieve volume for. By default this function will return all exchange volume.

    • direction: the direction in which to sort your results (by volume). The default is descending order. This function will accept "desc" or "asc".

    • start_date: only include data after this date (inclusive). This parameter will accept dates formatted as seconds, milliseconds, or iso8601.

    • end_date: only include data before this date (exclusive). The maximum time range is 31 days. This parameter will accept dates formatted as seconds, milliseconds, or iso8601.

    • time_format: the format to return your times in. Choose from: "milliseconds", "ms", "iso", "iso8601", "hr", and "human_readable". Default is "ms".

  • Returns: a dataframe with your volume data.

  • The following example retrieves the total trading volume on "gdax" between "2020-09-01T01:00:00" and "2020-09-02T01:00:00" and stores the resulting data in a dataframe named "volume".

api_key <- "..."
volume <- amberdata_historical_exchange_volume(api_key
                                               , "gdax"
                                               , "desc"
                                               , "2020-09-01T01:00:00"
                                               , "2020-09-02T01:00:00"
                                               , "hr")
Clone this wiki locally