Onchain Data Functions

SAN_ACTIVE_ADDRESSES

SAN_ACTIVE_ADDRESSES(projectSlug, from, to, interval) ⇒ Array

Returns the active addresses for the specified asset, during a given time interval. Active Addresses" refers to the number of unique addresses that participated in transactions on a blockchain.

  • Kind: global function
  • Returns: Array - of active addresses.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_ACTIVE_ADDRESSES_24H

SAN_ACTIVE_ADDRESSES_24H(projectSlug, from, to, interval) ⇒ Array

Returns the active addresses for the specified asset, during a given time interval. Active Addresses" refers to the number of unique addresses that participated in transactions on a blockchain.

  • Kind: global function
  • Returns: Array - of active addresses for the last 24 hours.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_ACTIVE_ADDRESSES_24H_AGGREGATED

SAN_ACTIVE_ADDRESSES_24H_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the active addresses for the specified asset, during a given time interval. Active Addresses" refers to the number of unique addresses that participated in transactions on a blockchain.

  • Kind: global function
  • Returns: number - of aggregated active addresses for the last 24 hours.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_ACTIVE_ADDRESSES_24H_MULTIPLE_SLUGS

SAN_ACTIVE_ADDRESSES_24H_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the active addresses for the specified asset, during a given time interval. Active Addresses" refers to the number of unique addresses that participated in transactions on a blockchain.

  • Kind: global function
  • Returns: Array - of results for multiple slugs active addresses for the last 24 hours.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_ACTIVE_ADDRESSES_AGGREGATED

SAN_ACTIVE_ADDRESSES_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the active addresses for the specified asset, during a given time interval. Active Addresses" refers to the number of unique addresses that participated in transactions on a blockchain.

  • Kind: global function
  • Returns: number - of aggregated active addresses.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_ACTIVE_ADDRESSES_MULTIPLE_SLUGS

SAN_ACTIVE_ADDRESSES_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the active addresses for the specified asset, during a given time interval. Active Addresses" refers to the number of unique addresses that participated in transactions on a blockchain.

  • Kind: global function
  • Returns: Array - of results for multiple slugs active addresses.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_ACTIVE_DEPOSITS

SAN_ACTIVE_DEPOSITS(projectSlug, from, to, interval) ⇒ Array

Returns number of unique deposit addresses that have been active for a project.

  • Kind: global function
  • Returns: Array - of deposit address numbers.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_ACTIVE_DEPOSITS_AGGREGATED

SAN_ACTIVE_DEPOSITS_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns number of unique deposit addresses that have been active for a project.

  • Kind: global function
  • Returns: number - of aggregated deposit address numbers.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_ACTIVE_DEPOSITS_MULTIPLE_SLUGS

SAN_ACTIVE_DEPOSITS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns number of unique deposit addresses that have been active for a project.

  • Kind: global function
  • Returns: Array - of results for multiple slugs deposit address numbers.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_AGE_DESTROYED

SAN_AGE_DESTROYED(projectSlug, from, to, interval) ⇒ Array

Returns the token's age destroyed

  • Kind: global function
  • Returns: Array - of age destroyed values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_AGE_DESTROYED_AGGREGATED

SAN_AGE_DESTROYED_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the token's age destroyed

  • Kind: global function
  • Returns: number - of aggregated age destroyed values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_AGE_DESTROYED_MULTIPLE_SLUGS

SAN_AGE_DESTROYED_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the token's age destroyed

  • Kind: global function
  • Returns: Array - of results for multiple slugs age destroyed values.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_ALL_PROJECTS

SAN_ALL_PROJECTS() ⇒ Array

Returns an array of all assets for which Santiment has data. Each asset record includes: ticker, name, slug, price in USD, market cap in USD, volume in USD, USD balance, ETH balance, ETH spent in the last 30 days, ETH spent in the last 7 days, ETH spent in the last day.

  • Kind: global function
  • Returns: Array - of all projects.
  • Customfunction:

SAN_BITMEX_PERPETUAL_CONTRACT_FUNDING_RATE

SAN_BITMEX_PERPETUAL_CONTRACT_FUNDING_RATE(projectSlug, from, to, interval) ⇒ Array

Returns the funding rates that are paid by one of the sides of the perpetual contract to the other

  • Kind: global function
  • Returns: Array - of the funding rates that are paid by one of the sides of the perpetual contract to the other
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_BITMEX_PERPETUAL_CONTRACT_FUNDING_RATE_AGGREGATED

SAN_BITMEX_PERPETUAL_CONTRACT_FUNDING_RATE_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the funding rates that are paid by one of the sides of the perpetual contract to the other

  • Kind: global function
  • Returns: number - of aggregated the funding rates that are paid by one of the sides of the perpetual contract to the other
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_BITMEX_PERPETUAL_CONTRACT_FUNDING_RATE_MULTIPLE_SLUGS

SAN_BITMEX_PERPETUAL_CONTRACT_FUNDING_RATE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the funding rates that are paid by one of the sides of the perpetual contract to the other

  • Kind: global function
  • Returns: Array - of results for multiple slugs the funding rates that are paid by one of the sides of the perpetual contract to the other
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_BITMEX_PERPETUAL_OPEN_INTEREST

SAN_BITMEX_PERPETUAL_OPEN_INTEREST(projectSlug, from, to, interval) ⇒ Array

Returns the amount of open perpetual contracts currently on Bitmex's Project Ticker / USD trading pairs. When open interest reaches unusually high numbers, it can precede increased volatility in the coin’s price.

  • Kind: global function
  • Returns: Array - of the amount of open perpetual contracts.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_BITMEX_PERPETUAL_OPEN_INTEREST_AGGREGATED

SAN_BITMEX_PERPETUAL_OPEN_INTEREST_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the amount of open perpetual contracts currently on Bitmex's Project Ticker / USD trading pairs. When open interest reaches unusually high numbers, it can precede increased volatility in the coin’s price.

  • Kind: global function
  • Returns: number - of aggregated the amount of open perpetual contracts.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_BITMEX_PERPETUAL_OPEN_INTEREST_MULTIPLE_SLUGS

SAN_BITMEX_PERPETUAL_OPEN_INTEREST_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the amount of open perpetual contracts currently on Bitmex's Project Ticker / USD trading pairs. When open interest reaches unusually high numbers, it can precede increased volatility in the coin’s price.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the amount of open perpetual contracts.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DAILY_AVG_MARKETCAP

SAN_DAILY_AVG_MARKETCAP(projectSlug, from, to, currency, interval) ⇒ Array

Returns the daily average marketcap.

  • Kind: global function
  • Returns: Array - of daily average marketcaps.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DAILY_AVG_MARKETCAP_AGGREGATED

SAN_DAILY_AVG_MARKETCAP_AGGREGATED(projectSlug, from, to, currency, aggregation) ⇒ number

Returns the daily average marketcap.

  • Kind: global function
  • Returns: number - of aggregated daily average marketcaps.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_DAILY_AVG_MARKETCAP_MULTIPLE_SLUGS

SAN_DAILY_AVG_MARKETCAP_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒ Array

Returns the daily average marketcap.

  • Kind: global function
  • Returns: Array - of results for multiple slugs daily average marketcaps.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DAILY_CLOSING_MARKETCAP

SAN_DAILY_CLOSING_MARKETCAP(projectSlug, from, to, currency, interval) ⇒ Array

Returns the daily closing marketcap.

  • Kind: global function
  • Returns: Array - of daily closing marketcaps.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DAILY_CLOSING_MARKETCAP_AGGREGATED

SAN_DAILY_CLOSING_MARKETCAP_AGGREGATED(projectSlug, from, to, currency, aggregation) ⇒ number

Returns the daily closing marketcap.

  • Kind: global function
  • Returns: number - of aggregated daily closing marketcaps.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_DAILY_CLOSING_MARKETCAP_MULTIPLE_SLUGS

SAN_DAILY_CLOSING_MARKETCAP_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒ Array

Returns the daily closing marketcap.

  • Kind: global function
  • Returns: Array - of results for multiple slugs daily closing marketcaps.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DAILY_CLOSING_PRICE

SAN_DAILY_CLOSING_PRICE(projectSlug, day) ⇒ number

Returns the closing price for a given day.

  • Kind: global function
  • Returns: number - closing price.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
daydateThe date to fetch the data. Example: DATE(2018, 9, 20)

SAN_DAILY_DEPOSIT_TRANSACTIONS

SAN_DAILY_DEPOSIT_TRANSACTIONS(projectSlug, from, to, interval) ⇒ Array

Returns number of withdrawal transactions.

  • Kind: global function
  • Returns: Array - of number of withdrawal transactions.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DAILY_DEPOSIT_TRANSACTIONS_AGGREGATED

SAN_DAILY_DEPOSIT_TRANSACTIONS_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns number of withdrawal transactions.

  • Kind: global function
  • Returns: number - of aggregated number of withdrawal transactions.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_DAILY_DEPOSIT_TRANSACTIONS_MULTIPLE_SLUGS

SAN_DAILY_DEPOSIT_TRANSACTIONS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns number of withdrawal transactions.

  • Kind: global function
  • Returns: Array - of results for multiple slugs number of withdrawal transactions.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DAILY_WITHDRAWAL_TRANSACTIONS

SAN_DAILY_WITHDRAWAL_TRANSACTIONS(projectSlug, from, to, interval) ⇒ Array

Returns number of withdrawal transactions.

  • Kind: global function
  • Returns: Array - of number of withdrawal transactions.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DAILY_WITHDRAWAL_TRANSACTIONS_AGGREGATED

SAN_DAILY_WITHDRAWAL_TRANSACTIONS_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns number of withdrawal transactions.

  • Kind: global function
  • Returns: number - of aggregated number of withdrawal transactions.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_DAILY_WITHDRAWAL_TRANSACTIONS_MULTIPLE_SLUGS

SAN_DAILY_WITHDRAWAL_TRANSACTIONS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns number of withdrawal transactions.

  • Kind: global function
  • Returns: Array - of results for multiple slugs number of withdrawal transactions.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DEPOSIT_TRANSACTIONS_BY_EXCHANGE

SAN_DEPOSIT_TRANSACTIONS_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array

Returns the deposit transactions for a slug in a specific exchange

  • Kind: global function
  • Returns: Array - exchange inflow values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
ownerstringName of the exchange
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DEPOSIT_TRANSACTIONS_INTRADAY

SAN_DEPOSIT_TRANSACTIONS_INTRADAY(projectSlug, from, to, interval) ⇒ Array

Returns number of withdrawal transactions with the option of smaller intervals.

  • Kind: global function
  • Returns: Array - of number of withdrawal transactions with the option of smaller intervals.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DEPOSIT_TRANSACTIONS_INTRADAY_AGGREGATED

SAN_DEPOSIT_TRANSACTIONS_INTRADAY_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns number of withdrawal transactions with the option of smaller intervals.

  • Kind: global function
  • Returns: number - of aggregated number of withdrawal transactions with the option of smaller intervals.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_DEPOSIT_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS

SAN_DEPOSIT_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns number of withdrawal transactions with the option of smaller intervals.

  • Kind: global function
  • Returns: Array - of results for multiple slugs number of withdrawal transactions with the option of smaller intervals.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_DEV_ACTIVITY

SAN_DEV_ACTIVITY(projectSlug, from, to) ⇒ Array

Returns a list of dev activity for a given slug and time interval.

  • Kind: global function
  • Returns: Array - of dev activity.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

Returns list of emerging trends and their corresponding trend score.

  • Kind: global function
  • Returns: Array - of trending words and their score.
  • Customfunction:
ParamTypeDescription
sizenumberAn integer showing how many words should be included in the top list (max 100).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_ERC20_PROJECTS

SAN_ERC20_PROJECTS() ⇒ Array

Returns an array of all ERC20 assets for which Santiment has data. Each asset record includes: ticker, name, slug, price in USD, market cap in USD, volume in USD, USD balance, ETH balance, ETH spent in the last 30 days, ETH spent in the last 7 days, ETH spent in the last day and main contract address.

  • Kind: global function
  • Returns: Array - of all ERC20 projects.
  • Customfunction:

SAN_ETH_SPENT_OVER_TIME

SAN_ETH_SPENT_OVER_TIME(projectSlug, from, to) ⇒ Array

Returns ETH spent for each interval from the project's team wallet and time period

  • Kind: global function
  • Returns: Array - of the ETH, that was spent over a given period of time
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_ETH_TOP_TRANSACTIONS

SAN_ETH_TOP_TRANSACTIONS(projectSlug, from, to, limit, transactionType) ⇒ Array

Returns top ETH transactions for project's team wallets.

  • Kind: global function
  • Returns: Array - of top transactions
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
limitnumberThe limit of transactions to be shown.
transactionTypestringAvailable transaction types: ALL, IN, OUT

SAN_EXCHANGE_BALANCE

SAN_EXCHANGE_BALANCE(projectSlug, from, to, interval) ⇒ Array

Returns the exchange balance.

  • Kind: global function
  • Returns: Array - of exchange balances.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_BALANCE_AGGREGATED

SAN_EXCHANGE_BALANCE_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the exchange balance.

  • Kind: global function
  • Returns: number - of aggregated exchange balances.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_EXCHANGE_BALANCE_BY_EXCHANGE

SAN_EXCHANGE_BALANCE_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array

Returns the exchange balance for a slug in a specific exchange

  • Kind: global function
  • Returns: Array - exchange inflow values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
ownerstringName of the exchange
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_BALANCE_MULTIPLE_SLUGS

SAN_EXCHANGE_BALANCE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the exchange balance.

  • Kind: global function
  • Returns: Array - of results for multiple slugs exchange balances.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_FUNDS_FLOW

SAN_EXCHANGE_FUNDS_FLOW(projectSlug, from, to) ⇒ Array

Returns the difference between the tokens that were deposited minus the tokens that were withdrawn from an exchange for a given slug and time interval.

  • Kind: global function
  • Returns: Array - of token deposit/withdraw differences.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_EXCHANGE_INFLOW

SAN_EXCHANGE_INFLOW(projectSlug, from, to, interval) ⇒ Array

Returns the exchange inflow.

  • Kind: global function
  • Returns: Array - of exchange inflows.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_INFLOW_AGGREGATED

SAN_EXCHANGE_INFLOW_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the exchange inflow.

  • Kind: global function
  • Returns: number - of aggregated exchange inflows.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_EXCHANGE_INFLOW_BY_EXCHANGE

SAN_EXCHANGE_INFLOW_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array

Returns the exchange inflow for a slug in a specific exchange

  • Kind: global function
  • Returns: Array - exchange inflow values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
ownerstringName of the exchange
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_INFLOW_MULTIPLE_SLUGS

SAN_EXCHANGE_INFLOW_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the exchange inflow.

  • Kind: global function
  • Returns: Array - of results for multiple slugs exchange inflows.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_OUTFLOW

SAN_EXCHANGE_OUTFLOW(projectSlug, from, to, interval) ⇒ Array

Returns the exchange outflow.

  • Kind: global function
  • Returns: Array - of exchange outflows.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_OUTFLOW_AGGREGATED

SAN_EXCHANGE_OUTFLOW_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the exchange outflow.

  • Kind: global function
  • Returns: number - of aggregated exchange outflows.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_EXCHANGE_OUTFLOW_BY_EXCHANGE

SAN_EXCHANGE_OUTFLOW_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array

Returns the exchange outflow for a slug in a specific exchange

  • Kind: global function
  • Returns: Array - exchange inflow values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
ownerstringName of the exchange
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_OUTFLOW_MULTIPLE_SLUGS

SAN_EXCHANGE_OUTFLOW_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the exchange outflow.

  • Kind: global function
  • Returns: Array - of results for multiple slugs exchange outflows.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_PERCENT_OF_SUPPLY

SAN_EXCHANGE_PERCENT_OF_SUPPLY(projectSlug, from, to, interval) ⇒ Array

Returns exchange percent of total supply.

  • Kind: global function
  • Returns: Array - of exchange percent of total supply.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_EXCHANGE_PERCENT_OF_SUPPLY_AGGREGATED

SAN_EXCHANGE_PERCENT_OF_SUPPLY_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns exchange percent of total supply.

  • Kind: global function
  • Returns: number - of aggregated exchange percent of total supply.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_EXCHANGE_PERCENT_OF_SUPPLY_MULTIPLE_SLUGS

SAN_EXCHANGE_PERCENT_OF_SUPPLY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns exchange percent of total supply.

  • Kind: global function
  • Returns: Array - of results for multiple slugs exchange percent of total supply.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_FUNCTIONS

SAN_FUNCTIONS() ⇒ Array

Returns all available functions.

  • Kind: global function
  • Returns: Array - of function names.
  • Customfunction:

SAN_FUNDING_RATE_BUSD

SAN_FUNDING_RATE_BUSD(projectSlug, from, to, fundingRateExchange, interval) ⇒ Array

Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).

  • Kind: global function
  • Returns: Array - of the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
fundingRateExchangestringThe exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" "FTX" "DYDX" "BITFINEX" "DERIBIT"
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_FUNDING_RATE_BUSD_AGGREGATED

SAN_FUNDING_RATE_BUSD_AGGREGATED(projectSlug, from, to, fundingRateExchange, aggregation) ⇒ number

Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).

  • Kind: global function
  • Returns: number - of aggregated the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
fundingRateExchangestringThe exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE"
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_FUNDING_RATE_BUSD_MULTIPLE_SLUGS

SAN_FUNDING_RATE_BUSD_MULTIPLE_SLUGS(projectSlugsList, from, to, fundingRateExchange, interval) ⇒ Array

Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).

  • Kind: global function
  • Returns: Array - of results for multiple slugs the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
fundingRateExchangestringThe exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE"
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_FUNDING_RATE_USDT

SAN_FUNDING_RATE_USDT(projectSlug, from, to, fundingRateExchange, interval) ⇒ Array

Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).

  • Kind: global function
  • Returns: Array - of the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
fundingRateExchangestringThe exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" "FTX" "DYDX" "BITFINEX" "DERIBIT"
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_FUNDING_RATE_USDT_AGGREGATED

SAN_FUNDING_RATE_USDT_AGGREGATED(projectSlug, from, to, fundingRateExchange, aggregation) ⇒ number

Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).

  • Kind: global function
  • Returns: number - of aggregated the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
fundingRateExchangestringThe exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE"
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_FUNDING_RATE_USDT_MULTIPLE_SLUGS

SAN_FUNDING_RATE_USDT_MULTIPLE_SLUGS(projectSlugsList, from, to, fundingRateExchange, interval) ⇒ Array

Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).

  • Kind: global function
  • Returns: Array - of results for multiple slugs the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
fundingRateExchangestringThe exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE"
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_GAS_USED

SAN_GAS_USED(projectSlug, from, to) ⇒ Array

Returns used Gas by a blockchain. When you send tokens, interact with a contract or do anything else on the blockchain, you must pay for that computation. That payment is calculated in Gas.

  • Kind: global function
  • Returns: Array - of quantities of gas used.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_GITHUB_ACTIVITY

SAN_GITHUB_ACTIVITY(projectSlug, from, to) ⇒ Array

Returns a list of github activity for a given slug and time interval.

  • Kind: global function
  • Returns: Array - of github activity.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_HISTORICAL_BALANCE

SAN_HISTORICAL_BALANCE(projectSlug, from, to, address) ⇒ Array

Returns the historical balance for a given ERC20 or ETH address.

  • Kind: global function
  • Returns: Array - of balances.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
addressstringERC20 or ETH address.

SAN_HISTORICAL_BALANCE_DEDUP

SAN_HISTORICAL_BALANCE_DEDUP(projectSlug, from, to, address) ⇒ Array

Returns the historical balance for a given ERC20 or ETH address.

  • Kind: global function
  • Returns: Array - of balances.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
addressstringERC20 or ETH address.

SAN_HISTORY_TWITTER_DATA

SAN_HISTORY_TWITTER_DATA(projectSlug, from, to) ⇒ Array

Returns the historical count of twitter followers.

  • Kind: global function
  • Returns: Array - followers count over time.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_HOLDERS_DISTRIBUTION

SAN_HOLDERS_DISTRIBUTION(projectSlug, from, to, balance, interval) ⇒ Array

Represents the total number of addresses holding the given amount of tokens.

  • Kind: global function
  • Returns: Array - of total number of addresses holding the given amount of tokens.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
balancestringInterval of amount of tokens. Available balance intervals are: "0-0.001", "0.001-0.01", "0.01-0.1", "0.1-1", "1-10", "10-100", "100-1k", "1k-10k", "10k-100k", "100k-1M", "1M-10M", "10M-100M", "100M-1B", "1B-inf", "total"
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_HOLDERS_DISTRIBUTION_AGGREGATED

SAN_HOLDERS_DISTRIBUTION_AGGREGATED(projectSlug, from, to, balance, aggregation) ⇒ number

Represents the total number of addresses holding the given amount of tokens.

  • Kind: global function
  • Returns: number - of aggregated total number of addresses holding the given amount of tokens.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
balancestringInterval of amount of tokens. Available balance intervals are: "0-0.001", "0.001-0.01", "0.01-0.1", "0.1-1", "1-10", "10-100", "100-1k", "1k-10k", "10k-100k", "100k-1M", "1M-10M", "10M-100M", "100M-1B", "1B-inf", "total"
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_HOLDERS_DISTRIBUTION_COMBINED_BALANCE

SAN_HOLDERS_DISTRIBUTION_COMBINED_BALANCE(projectSlug, from, to, balance, interval) ⇒ Array

Returns the number of tokens in a specific bucket.

  • Kind: global function
  • Returns: Array - of the number of tokens in a specific bucket.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
balancestringInterval of amount of tokens. Available balance intervals are: "0-0.001", "0.001-0.01", "0.01-0.1", "0.1-1", "1-10", "10-100", "100-1k", "1k-10k", "10k-100k", "100k-1M", "1M-10M", "10M-100M", "100M-1B", "1B-inf", "total"
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_HOLDERS_DISTRIBUTION_COMBINED_BALANCE_AGGREGATED

SAN_HOLDERS_DISTRIBUTION_COMBINED_BALANCE_AGGREGATED(projectSlug, from, to, balance, aggregation) ⇒ number

Returns the number of tokens in a specific bucket.

  • Kind: global function
  • Returns: number - of aggregated the number of tokens in a specific bucket.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
balancestringInterval of amount of tokens. Available balance intervals are: "0-0.001", "0.001-0.01", "0.01-0.1", "0.1-1", "1-10", "10-100", "100-1k", "1k-10k", "10k-100k", "100k-1M", "1M-10M", "10M-100M", "100M-1B", "1B-inf", "total"
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_HOLDERS_DISTRIBUTION_COMBINED_BALANCE_MULTIPLE_SLUGS

SAN_HOLDERS_DISTRIBUTION_COMBINED_BALANCE_MULTIPLE_SLUGS(projectSlugsList, from, to, balance, interval) ⇒ Array

Returns the number of tokens in a specific bucket.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the number of tokens in a specific bucket.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
balancestringInterval of amount of tokens. Available balance intervals are: "0-0.001", "0.001-0.01", "0.01-0.1", "0.1-1", "1-10", "10-100", "100-1k", "1k-10k", "10k-100k", "100k-1M", "1M-10M", "10M-100M", "100M-1B", "1B-inf", "total"
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_HOLDERS_DISTRIBUTION_MULTIPLE_SLUGS

SAN_HOLDERS_DISTRIBUTION_MULTIPLE_SLUGS(projectSlugsList, from, to, balance, interval) ⇒ Array

Represents the total number of addresses holding the given amount of tokens.

  • Kind: global function
  • Returns: Array - of results for multiple slugs total number of addresses holding the given amount of tokens.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
balancestringInterval of amount of tokens. Available balance intervals are: "0-0.001", "0.001-0.01", "0.01-0.1", "0.1-1", "1-10", "10-100", "100-1k", "1k-10k", "10k-100k", "100k-1M", "1M-10M", "10M-100M", "100M-1B", "1B-inf", "total"
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_LATEST_PRICE

SAN_LATEST_PRICE(projectSlug, currency) ⇒ number

Returns the latest price for a given asset in a desired currency.

  • Kind: global function
  • Returns: number - latest price.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
currencystringThe currency in which the data should be presented. Either "USD" or "BTC".

SAN_MARKETCAP

SAN_MARKETCAP(projectSlug, from, to, currency, interval) ⇒ Array

Returns the marketcap for a slug.

  • Kind: global function
  • Returns: Array - of the slug's marketcap.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MARKETCAP_AGGREGATED

SAN_MARKETCAP_AGGREGATED(projectSlug, from, to, currency, aggregation) ⇒ number

Returns the marketcap for a slug.

  • Kind: global function
  • Returns: number - of aggregated the slug's marketcap.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_MARKETCAP_MULTIPLE_SLUGS

SAN_MARKETCAP_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒ Array

Returns the marketcap for a slug.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the slug's marketcap.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MEAN_AGE

SAN_MEAN_AGE(projectSlug, from, to, interval) ⇒ Array

Returns the token's mean age.

  • Kind: global function
  • Returns: Array - of mean age values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MEAN_AGE_AGGREGATED

SAN_MEAN_AGE_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the token's mean age.

  • Kind: global function
  • Returns: number - of aggregated mean age values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_MEAN_AGE_MULTIPLE_SLUGS

SAN_MEAN_AGE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the token's mean age.

  • Kind: global function
  • Returns: Array - of results for multiple slugs mean age values.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MEAN_DOLLAR_INVESTED_AGE

SAN_MEAN_DOLLAR_INVESTED_AGE(projectSlug, from, to, interval) ⇒ Array

Returns the token's mean dollar invested age.

  • Kind: global function
  • Returns: Array - of mean dollar invested age values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MEAN_DOLLAR_INVESTED_AGE_AGGREGATED

SAN_MEAN_DOLLAR_INVESTED_AGE_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the token's mean dollar invested age.

  • Kind: global function
  • Returns: number - of aggregated mean dollar invested age values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_MEAN_DOLLAR_INVESTED_AGE_MULTIPLE_SLUGS

SAN_MEAN_DOLLAR_INVESTED_AGE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the token's mean dollar invested age.

  • Kind: global function
  • Returns: Array - of results for multiple slugs mean dollar invested age values.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MEAN_REALIZED_PRICE

SAN_MEAN_REALIZED_PRICE(projectSlug, from, to, currency, timeBound, interval) ⇒ Array

Returns the mean realized price.

  • Kind: global function
  • Returns: Array - of mean realized prices.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years or days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MEAN_REALIZED_PRICE_AGGREGATED

SAN_MEAN_REALIZED_PRICE_AGGREGATED(projectSlug, from, to, currency, timeBound, aggregation) ⇒ number

Returns the mean realized price.

  • Kind: global function
  • Returns: number - of aggregated mean realized prices.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_MEAN_REALIZED_PRICE_MULTIPLE_SLUGS

SAN_MEAN_REALIZED_PRICE_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, timeBound, interval) ⇒ Array

Returns the mean realized price.

  • Kind: global function
  • Returns: Array - of results for multiple slugs mean realized prices.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MINERS_BALANCE

SAN_MINERS_BALANCE(projectSlug, from, to) ⇒ Array

Returns miners balances over time Currently only ETH is supported.

  • Kind: global function
  • Returns: Array - of balances.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_MINING_POOLS_DISTRIBUTION

SAN_MINING_POOLS_DISTRIBUTION(projectSlug, from, to) ⇒ Array

Returns the distribution of miners between mining pools. What part of the miners are using top3, top10 and all the other pools. Currently only ETH is supported.

  • Kind: global function
  • Returns: Array - of distribution ratios.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_MVRV_LONG_SHORT_DIFF

SAN_MVRV_LONG_SHORT_DIFF(projectSlug, from, to, currency, interval) ⇒ Array

Returns the difference between MVRV.

  • Kind: global function
  • Returns: Array - of MVRV differences.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MVRV_LONG_SHORT_DIFF_AGGREGATED

SAN_MVRV_LONG_SHORT_DIFF_AGGREGATED(projectSlug, from, to, currency, aggregation) ⇒ number

Returns the difference between MVRV.

  • Kind: global function
  • Returns: number - of aggregated MVRV differences.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_MVRV_LONG_SHORT_DIFF_MULTIPLE_SLUGS

SAN_MVRV_LONG_SHORT_DIFF_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒ Array

Returns the difference between MVRV.

  • Kind: global function
  • Returns: Array - of results for multiple slugs MVRV differences.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MVRV_RATIO

SAN_MVRV_RATIO(projectSlug, from, to, currency, timeBound, interval) ⇒ Array

Returns MVRV(Market-Value-to-Realized-Value).

  • Kind: global function
  • Returns: Array - of MVRV ratios.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years or days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MVRV_RATIO_AGGREGATED

SAN_MVRV_RATIO_AGGREGATED(projectSlug, from, to, currency, timeBound, aggregation) ⇒ number

Returns MVRV(Market-Value-to-Realized-Value).

  • Kind: global function
  • Returns: number - of aggregated MVRV ratios.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_MVRV_RATIO_INTRADAY

SAN_MVRV_RATIO_INTRADAY(projectSlug, from, to, timeBound, interval) ⇒ Array

Returns MVRV(Market-Value-to-Realized-Value) with the option of smaller intervals.

  • Kind: global function
  • Returns: Array - of MVRV ratios with the option of smaller intervals.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years or days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MVRV_RATIO_INTRADAY_AGGREGATED

SAN_MVRV_RATIO_INTRADAY_AGGREGATED(projectSlug, from, to, timeBound, aggregation) ⇒ number

Returns MVRV(Market-Value-to-Realized-Value) with the option of smaller intervals.

  • Kind: global function
  • Returns: number - of aggregated MVRV ratios with the option of smaller intervals.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_MVRV_RATIO_INTRADAY_MULTIPLE_SLUGS

SAN_MVRV_RATIO_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, timeBound, interval) ⇒ Array

Returns MVRV(Market-Value-to-Realized-Value) with the option of smaller intervals.

  • Kind: global function
  • Returns: Array - of results for multiple slugs MVRV ratios with the option of smaller intervals.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MVRV_RATIO_MULTIPLE_SLUGS

SAN_MVRV_RATIO_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, timeBound, interval) ⇒ Array

Returns MVRV(Market-Value-to-Realized-Value).

  • Kind: global function
  • Returns: Array - of results for multiple slugs MVRV ratios.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MVRV_Z_SCORE

SAN_MVRV_Z_SCORE(projectSlug, from, to, interval) ⇒ Array

Returns the MVRV Z score.

  • Kind: global function
  • Returns: Array - of the MVRV Z score.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_MVRV_Z_SCORE_AGGREGATED

SAN_MVRV_Z_SCORE_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the MVRV Z score.

  • Kind: global function
  • Returns: number - of aggregated the MVRV Z score.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_MVRV_Z_SCORE_MULTIPLE_SLUGS

SAN_MVRV_Z_SCORE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the MVRV Z score.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the MVRV Z score.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_NETWORK_GROWTH

SAN_NETWORK_GROWTH(projectSlug, from, to, interval) ⇒ Array

Returns the token's network growth

  • Kind: global function
  • Returns: Array - of network growth.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_NETWORK_GROWTH_AGGREGATED

SAN_NETWORK_GROWTH_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the token's network growth

  • Kind: global function
  • Returns: number - of aggregated network growth.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_NETWORK_GROWTH_MULTIPLE_SLUGS

SAN_NETWORK_GROWTH_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the token's network growth

  • Kind: global function
  • Returns: Array - of results for multiple slugs network growth.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_NETWORK_PROFIT_LOSS

SAN_NETWORK_PROFIT_LOSS(projectSlug, from, to, interval) ⇒ Array

Returns the network's profit/loss.

  • Kind: global function
  • Returns: Array - of the network's profit/loss.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_NETWORK_PROFIT_LOSS_AGGREGATED

SAN_NETWORK_PROFIT_LOSS_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the network's profit/loss.

  • Kind: global function
  • Returns: number - of aggregated the network's profit/loss.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_NETWORK_PROFIT_LOSS_MULTIPLE_SLUGS

SAN_NETWORK_PROFIT_LOSS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the network's profit/loss.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the network's profit/loss.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_NVT_RATIO

SAN_NVT_RATIO(projectSlug, from, to, interval) ⇒ Array

Returns NVT (Network-Value-to-Transactions-Ratio Daily Market Cap / Daily Token Circulation) Since Daily Transaction Volume gets rather noisy and easy to manipulate by transferring the same tokens through a couple of addresses repeatedly, it’s not an ideal measure of a network’s economic activity. That’s why we also offer another way to calculate NVT by using Daily Token Circulation. This method filters out excess transactions and provides a cleaner overview of a blockchain’s daily transaction throughput.

  • Kind: global function
  • Returns: Array - of NVT ratios
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_NVT_RATIO_AGGREGATED

SAN_NVT_RATIO_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns NVT (Network-Value-to-Transactions-Ratio Daily Market Cap / Daily Token Circulation) Since Daily Transaction Volume gets rather noisy and easy to manipulate by transferring the same tokens through a couple of addresses repeatedly, it’s not an ideal measure of a network’s economic activity. That’s why we also offer another way to calculate NVT by using Daily Token Circulation. This method filters out excess transactions and provides a cleaner overview of a blockchain’s daily transaction throughput.

  • Kind: global function
  • Returns: number - of aggregated NVT ratios
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_NVT_RATIO_MULTIPLE_SLUGS

SAN_NVT_RATIO_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns NVT (Network-Value-to-Transactions-Ratio Daily Market Cap / Daily Token Circulation) Since Daily Transaction Volume gets rather noisy and easy to manipulate by transferring the same tokens through a couple of addresses repeatedly, it’s not an ideal measure of a network’s economic activity. That’s why we also offer another way to calculate NVT by using Daily Token Circulation. This method filters out excess transactions and provides a cleaner overview of a blockchain’s daily transaction throughput.

  • Kind: global function
  • Returns: Array - of results for multiple slugs NVT ratios
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_OHLC

SAN_OHLC(projectSlug, from, to) ⇒ Array

Returns the open, high, low, and close price values for the specified asset, during a given time interval.

  • Kind: global function
  • Returns: Array - of open, high, low, and close price values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_PRICE

SAN_PRICE(projectSlug, from, to, currency, interval) ⇒ Array

Returns the prices for the slug in the given time period.

  • Kind: global function
  • Returns: Array - of the prices for the slug in the given time period.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_PRICE_ABSOLUTE_CHANGE

SAN_PRICE_ABSOLUTE_CHANGE(projectSlug, from, to) ⇒ number

Returns the absolute price change for the specified asset, during a given time interval.

  • Kind: global function
  • Returns: number - absolute price change.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_PRICE_AGGREGATED

SAN_PRICE_AGGREGATED(projectSlug, from, to, currency, aggregation) ⇒ number

Returns the prices for the slug in the given time period.

  • Kind: global function
  • Returns: number - of aggregated the prices for the slug in the given time period.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_PRICE_MULTIPLE_SLUGS

SAN_PRICE_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒ Array

Returns the prices for the slug in the given time period.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the prices for the slug in the given time period.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_PRICE_PERCENT_CHANGE

SAN_PRICE_PERCENT_CHANGE(projectSlug, from, to) ⇒ number

Returns the percent price change for the specified asset, during a given time interval.

  • Kind: global function
  • Returns: number - price change in percent.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_PRICE_VOLUME

SAN_PRICE_VOLUME(projectSlug, from, to, interval) ⇒ Array

Returns the prices for the specified asset, during a given time interval.

  • Kind: global function
  • Returns: Array - of prices.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_PRICE_VOLUME_DIFF

SAN_PRICE_VOLUME_DIFF(currency, projectSlug, from, to) ⇒ Array

Returns the price-volume difference technical indicator for a given asset, currency and time interval. This indicator measures the difference in trend between price and volume, specifically when price goes up as volume goes down. Currency can be displayed in either USD or BTC.

  • Kind: global function
  • Returns: Array - of price-volume difference technical indicator.
  • Customfunction:
ParamTypeDescription
currencystringThe currency in which the data should be presented. Either "USD" or "BTC".
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_PRICES

SAN_PRICES(projectSlug, from, to, interval) ⇒ Array

Returns the prices for the specified asset, during a given time interval.

  • Kind: global function
  • Returns: Array - of prices.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_PROJECT_FUNDAMENTALS

SAN_PROJECT_FUNDAMENTALS(projectSlug) ⇒ Array

Fetch fundamentals for a specified project.

  • Kind: global function
  • Returns: Array - of project details.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).

SAN_REALIZED_VALUE

SAN_REALIZED_VALUE(projectSlug, from, to, currency, timeBound, interval) ⇒ Array

Returns Realized value - sum of the acquisition costs of an asset located in a wallet. The realized value across the whole network is computed by summing the realized values of all wallets holding tokens at the moment.

  • Kind: global function
  • Returns: Array - of realized values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years or days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_REALIZED_VALUE_AGGREGATED

SAN_REALIZED_VALUE_AGGREGATED(projectSlug, from, to, currency, timeBound, aggregation) ⇒ number

Returns Realized value - sum of the acquisition costs of an asset located in a wallet. The realized value across the whole network is computed by summing the realized values of all wallets holding tokens at the moment.

  • Kind: global function
  • Returns: number - of aggregated realized values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_REALIZED_VALUE_MULTIPLE_SLUGS

SAN_REALIZED_VALUE_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, timeBound, interval) ⇒ Array

Returns Realized value - sum of the acquisition costs of an asset located in a wallet. The realized value across the whole network is computed by summing the realized values of all wallets holding tokens at the moment.

  • Kind: global function
  • Returns: Array - of results for multiple slugs realized values.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_REVERSE

SAN_REVERSE(array) ⇒ Array

Returns the reversed array of the results

  • Kind: global function
  • Returns: Array - of reversed results
  • Customfunction:
ParamTypeDescription
arrayarrayThe array of results

SAN_TOKEN_AGE_CONSUMED

SAN_TOKEN_AGE_CONSUMED(projectSlug, from, to) ⇒ Array

Returns amount of tokens changing addresses, multiplied by the number of blocks created on the blockchain since they last moved. Spikes are signal of a large amount of tokens moving after being idle for an extended period of time.

Grouping by interval works by summing all records in the interval.

  • Kind: global function
  • Returns: Array - of token age consumed numbers.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_TOKEN_CIRCULATION

SAN_TOKEN_CIRCULATION(projectSlug, from, to, timeBound, interval) ⇒ Array

Returns token circulation for a given slug and time interval.

  • Kind: global function
  • Returns: Array - of token circulation values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years or days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TOKEN_CIRCULATION_AGGREGATED

SAN_TOKEN_CIRCULATION_AGGREGATED(projectSlug, from, to, timeBound, aggregation) ⇒ number

Returns token circulation for a given slug and time interval.

  • Kind: global function
  • Returns: number - of aggregated token circulation values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_TOKEN_CIRCULATION_MULTIPLE_SLUGS

SAN_TOKEN_CIRCULATION_MULTIPLE_SLUGS(projectSlugsList, from, to, timeBound, interval) ⇒ Array

Returns token circulation for a given slug and time interval.

  • Kind: global function
  • Returns: Array - of results for multiple slugs token circulation values.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
timeBoundstringThe metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TOKEN_TOP_TRANSACTIONS

SAN_TOKEN_TOP_TRANSACTIONS(projectSlug, from, to, limit) ⇒ Array

Returns top token transactions for a given slug

  • Kind: global function
  • Returns: Array - of top transactions
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
limitnumberThe limit of transactions to be shown.

SAN_TOP_HOLDERS_HELD_OFF_EXCHANGE

SAN_TOP_HOLDERS_HELD_OFF_EXCHANGE(projectSlug, from, to, interval) ⇒ Array

Returns the amount of coins/tokens held only by the non exchange top holders.

  • Kind: global function
  • Returns: Array - of amount of coins/tokens held only by the top holders.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TOP_HOLDERS_HELD_ON_EXCHANGE

SAN_TOP_HOLDERS_HELD_ON_EXCHANGE(projectSlug, from, to, interval) ⇒ Array

Returns the amount of coins/tokens held only by the exchange top holders.

  • Kind: global function
  • Returns: Array - of amount of coins/tokens held only by the top holders.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TOP_HOLDERS_HELD_OVERALL

SAN_TOP_HOLDERS_HELD_OVERALL(projectSlug, from, to, interval) ⇒ Array

Returns the amount of coins/tokens held by the top holders.

  • Kind: global function
  • Returns: Array - of amount of coins/tokens held by the top holders.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TOP_HOLDERS_PERCENT_OF_TOTAL_SUPPLY

SAN_TOP_HOLDERS_PERCENT_OF_TOTAL_SUPPLY(projectSlug, from, to, numberOfHolders) ⇒ Array

Returns the top holders' percent of total supply - in exchanges, outside exchanges and combined.

  • Kind: global function
  • Returns: Array - followers count over time.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment).
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
numberOfHoldersnumberTake top number of holders into account when calculating.

SAN_TRADING_VOLUME

SAN_TRADING_VOLUME(projectSlug, from, to, currency, interval) ⇒ Array

Returns the slug's trading volume.

  • Kind: global function
  • Returns: Array - of the slugs's trading volume.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TRADING_VOLUME_AGGREGATED

SAN_TRADING_VOLUME_AGGREGATED(projectSlug, from, to, currency, aggregation) ⇒ number

Returns the slug's trading volume.

  • Kind: global function
  • Returns: number - of aggregated the slugs's trading volume.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_TRADING_VOLUME_MULTIPLE_SLUGS

SAN_TRADING_VOLUME_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒ Array

Returns the slug's trading volume.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the slugs's trading volume.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
currencystringThe metric is calculated using a currency of choice. Available currencies: USD
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TRANSACTION_VOLUME

SAN_TRANSACTION_VOLUME(projectSlug, from, to, interval) ⇒ Array

Gets the transaction volume for the specified asset, during a given time interval. Transaction Volume" refers to the total number of tokens within all transfers that have occurred on a blockchain.

  • Kind: global function
  • Returns: Array - of transaction volumes.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TRANSACTION_VOLUME_AGGREGATED

SAN_TRANSACTION_VOLUME_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Gets the transaction volume for the specified asset, during a given time interval. Transaction Volume" refers to the total number of tokens within all transfers that have occurred on a blockchain.

  • Kind: global function
  • Returns: number - of aggregated transaction volumes.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_TRANSACTION_VOLUME_LOSS

SAN_TRANSACTION_VOLUME_LOSS(projectSlug, from, to, interval) ⇒ Array

Returns the transaction volume in loss.

  • Kind: global function
  • Returns: Array - of the transaction volume in loss.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TRANSACTION_VOLUME_LOSS_AGGREGATED

SAN_TRANSACTION_VOLUME_LOSS_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the transaction volume in loss.

  • Kind: global function
  • Returns: number - of aggregated the transaction volume in loss.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_TRANSACTION_VOLUME_LOSS_MULTIPLE_SLUGS

SAN_TRANSACTION_VOLUME_LOSS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the transaction volume in loss.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the transaction volume in loss.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TRANSACTION_VOLUME_MULTIPLE_SLUGS

SAN_TRANSACTION_VOLUME_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Gets the transaction volume for the specified asset, during a given time interval. Transaction Volume" refers to the total number of tokens within all transfers that have occurred on a blockchain.

  • Kind: global function
  • Returns: Array - of results for multiple slugs transaction volumes.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TRANSACTION_VOLUME_PROFIT

SAN_TRANSACTION_VOLUME_PROFIT(projectSlug, from, to, interval) ⇒ Array

Returns the transaction volume in profit.

  • Kind: global function
  • Returns: Array - of the transaction volume in profit.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TRANSACTION_VOLUME_PROFIT_AGGREGATED

SAN_TRANSACTION_VOLUME_PROFIT_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the transaction volume in profit.

  • Kind: global function
  • Returns: number - of aggregated the transaction volume in profit.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO

SAN_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO(projectSlug, from, to, interval) ⇒ Array

Returns the ratio between transaction volume in profit and transaction volume in loss.

  • Kind: global function
  • Returns: Array - of the ratio between transaction volume in profit and transaction volume in loss.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO_AGGREGATED

SAN_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the ratio between transaction volume in profit and transaction volume in loss.

  • Kind: global function
  • Returns: number - of aggregated the ratio between transaction volume in profit and transaction volume in loss.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO_MULTIPLE_SLUGS

SAN_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the ratio between transaction volume in profit and transaction volume in loss.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the ratio between transaction volume in profit and transaction volume in loss.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_TRANSACTION_VOLUME_PROFIT_MULTIPLE_SLUGS

SAN_TRANSACTION_VOLUME_PROFIT_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the transaction volume in profit.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the transaction volume in profit.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_VELOCITY

SAN_VELOCITY(projectSlug, from, to, interval) ⇒ Array

Returns the token's velocity.

  • Kind: global function
  • Returns: Array - of token velocity values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_VELOCITY_AGGREGATED

SAN_VELOCITY_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the token's velocity.

  • Kind: global function
  • Returns: number - of aggregated token velocity values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_VELOCITY_MULTIPLE_SLUGS

SAN_VELOCITY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the token's velocity.

  • Kind: global function
  • Returns: Array - of results for multiple slugs token velocity values.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_VOLUME

SAN_VOLUME(projectSlug, from, to, interval) ⇒ Array

Returns the slug's transaction volume.

  • Kind: global function
  • Returns: Array - of the slug's transaction volume.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_VOLUME_AGGREGATED

SAN_VOLUME_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the slug's transaction volume.

  • Kind: global function
  • Returns: number - of aggregated the slug's transaction volume.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_VOLUME_MULTIPLE_SLUGS

SAN_VOLUME_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the slug's transaction volume.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the slug's transaction volume.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_WHALE_TRANSACTION_COUNT

SAN_WHALE_TRANSACTION_COUNT(projectSlug, from, to, interval) ⇒ Array

Returns the number of transactions transferring more than 100k USD.

  • Kind: global function
  • Returns: Array - of the number of transactions transferring more than 100k USD.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_WHALE_TRANSACTION_COUNT_AGGREGATED

SAN_WHALE_TRANSACTION_COUNT_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns the number of transactions transferring more than 100k USD.

  • Kind: global function
  • Returns: number - of aggregated the number of transactions transferring more than 100k USD.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_WHALE_TRANSACTION_COUNT_MULTIPLE_SLUGS

SAN_WHALE_TRANSACTION_COUNT_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns the number of transactions transferring more than 100k USD.

  • Kind: global function
  • Returns: Array - of results for multiple slugs the number of transactions transferring more than 100k USD.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_WITHDRAWAL_TRANSACTIONS_BY_EXCHANGE

SAN_WITHDRAWAL_TRANSACTIONS_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array

Returns the withdrawal transactions for a slug in a specific exchange

  • Kind: global function
  • Returns: Array - exchange inflow values.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
ownerstringName of the exchange
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY

SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY(projectSlug, from, to, interval) ⇒ Array

Returns number of withdrawal transactions with the option of smaller intervals.

  • Kind: global function
  • Returns: Array - of number of withdrawal transactions with the option of smaller intervals.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"

SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_AGGREGATED

SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number

Returns number of withdrawal transactions with the option of smaller intervals.

  • Kind: global function
  • Returns: number - of aggregated number of withdrawal transactions with the option of smaller intervals.
  • Customfunction:
ParamTypeDescription
projectSlugstringName of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregationstringAggregation for the timeseries metrics. Example: "LAST"

SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS

SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array

Returns number of withdrawal transactions with the option of smaller intervals.

  • Kind: global function
  • Returns: Array - of results for multiple slugs number of withdrawal transactions with the option of smaller intervals.
  • Customfunction:
ParamTypeDescription
projectSlugsListstringComma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin".
fromdateThe starting date to fetch the data. Example: DATE(2018, 9, 20)
todateThe ending date to fetch the data. Example: DATE(2018, 9, 21)
intervalstringThe resolution with which the data is fetched. Example: "5m"