Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
1943 lines (1556 sloc) 114 KB

Functions

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.

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.

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.

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.

SAN_ACTIVE_DEPOSITS(projectSlug, from, to, interval)Array

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

SAN_ACTIVE_DEPOSITS_AGGREGATED(projectSlug, from, to, aggregation)number

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

SAN_AGE_DESTROYED(projectSlug, from, to, interval)Array

Returns the token's age destroyed

SAN_AGE_DESTROYED_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the token's age destroyed

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.

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

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

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.

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.

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

Returns the daily average marketcap.

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

Returns the daily average marketcap.

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

Returns the daily closing marketcap.

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

Returns the daily closing marketcap.

SAN_DAILY_CLOSING_PRICE(projectSlug, day)number

Returns the closing price for a given day.

SAN_DEV_ACTIVITY(projectSlug, from, to)Array

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

SAN_EMERGING_TRENDS(size, from, to)Array

Returns list of emerging trends and their corresponding trend score.

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.

SAN_ETH_SPENT_OVER_TIME(projectSlug, from, to)Array

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

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

Returns top ETH transactions for project's team wallets.

SAN_EXCHANGE_BALANCE(projectSlug, from, to, interval)Array

Returns the exchange balance.

SAN_EXCHANGE_BALANCE_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the exchange balance.

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.

SAN_EXCHANGE_INFLOW(projectSlug, from, to, interval)Array

Returns the exchange inflow.

SAN_EXCHANGE_INFLOW_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the exchange inflow.

SAN_EXCHANGE_OUTFLOW(projectSlug, from, to, interval)Array

Returns the exchange outflow.

SAN_EXCHANGE_OUTFLOW_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the exchange outflow.

SAN_EXCHANGE_PERCENT_OF_SUPPLY(projectSlug, from, to, interval)Array

Returns exchange percent of total supply.

SAN_EXCHANGE_PERCENT_OF_SUPPLY_AGGREGATED(projectSlug, from, to, aggregation)number

Returns exchange percent of total supply.

SAN_FUNCTIONS()Array

Returns all available functions.

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.

SAN_GITHUB_ACTIVITY(projectSlug, from, to)Array

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

SAN_HISTORICAL_BALANCE(projectSlug, from, to, address)Array

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

SAN_HISTORICAL_BALANCE_DEDUP(projectSlug, from, to, address)Array

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

SAN_HISTORY_TWITTER_DATA(projectSlug, from, to)Array

Returns the historical count of twitter followers.

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

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

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

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

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

Returns the number of tokens in a specific bucket.

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

Returns the number of tokens in a specific bucket.

SAN_LATEST_PRICE(projectSlug, currency)number

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

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

Returns the marketcap for a slug.

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

Returns the marketcap for a slug.

SAN_MEAN_AGE(projectSlug, from, to, interval)Array

Returns the token's mean age.

SAN_MEAN_AGE_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the token's mean age.

SAN_MEAN_DOLLAR_INVESTED_AGE(projectSlug, from, to, interval)Array

Returns the token's mean dollar invested age.

SAN_MEAN_DOLLAR_INVESTED_AGE_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the token's mean dollar invested age.

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

Returns the mean realized price.

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

Returns the mean realized price.

SAN_MINERS_BALANCE(projectSlug, from, to)Array

Returns miners balances over time Currently only ETH is supported.

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.

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

Returns the difference between MVRV.

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

Returns the difference between MVRV.

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

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

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

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

SAN_NETWORK_GROWTH(projectSlug, from, to, interval)Array

Returns the token's network growth

SAN_NETWORK_GROWTH_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the token's network growth

SAN_NETWORK_PROFIT_LOSS(projectSlug, from, to, interval)Array

Returns the network's profit/loss.

SAN_NETWORK_PROFIT_LOSS_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the network's profit/loss.

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.

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.

SAN_OHLC(projectSlug, from, to)Array

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

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

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

SAN_PRICE_ABSOLUTE_CHANGE(projectSlug, from, to)number

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

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

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

SAN_PRICE_PERCENT_CHANGE(projectSlug, from, to)number

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

SAN_PRICE_VOLUME(projectSlug, from, to, interval)Array

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

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.

SAN_PRICES(projectSlug, from, to, interval)Array

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

SAN_PROJECT_FUNDAMENTALS(projectSlug)Array

Fetch fundamentals for a specified project.

SAN_PROJECT_SOCIAL_DATA(projectSlug)Array

Returns social data for a specified project.

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.

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.

SAN_REVERSE(array)Array

Returns the reversed array of the results

SAN_SOCIAL_DOMINANCE(projectSlug, from, to, source)Array

Returns the % of the social dominance a given project has over time in a given social channel.

SAN_SOCIAL_VOLUME(projectSlug, from, to, source, interval)Array

Returns the social volume for a slug.

SAN_SOCIAL_VOLUME_AGGREGATED(projectSlug, from, to, source, aggregation)number

Returns the social volume for a slug.

SAN_SOCIAL_VOLUME_PROJECTS()Array

Returns a list of project slugs for which there is social volume data.

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.

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

Returns token circulation for a given slug and time interval.

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

Returns token circulation for a given slug and time interval.

SAN_TOKEN_TOP_TRANSACTIONS(projectSlug, from, to, limit)Array

Returns top token transactions for a given slug

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.

SAN_TOP_HOLDERS_HELD_ON_EXCHANGE(projectSlug, from, to, interval)Array

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

SAN_TOP_HOLDERS_HELD_OVERALL(projectSlug, from, to, interval)Array

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

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.

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.

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.

SAN_VELOCITY(projectSlug, from, to, interval)Array

Returns the token's velocity.

SAN_VELOCITY_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the token's velocity.

SAN_VOLUME(projectSlug, from, to, interval)Array

Returns the slug's trading volume.

SAN_VOLUME_AGGREGATED(projectSlug, from, to, aggregation)number

Returns the slug's trading volume.

SAN_WEIGHTED_SOCIAL_SENTIMENT(projectSlug, from, to, source, interval)Array

Returns the weighted social sentiment for a slug.

SAN_WEIGHTED_SOCIAL_SENTIMENT_AGGREGATED(projectSlug, from, to, source, aggregation)number

Returns the weighted social sentiment for a slug.

SAN_WHALE_TRANSACTION_COUNT(projectSlug, from, to, interval)Array

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

SAN_WHALE_TRANSACTION_COUNT_AGGREGATED(projectSlug, from, to, aggregation)number

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

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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

Returns the token's age destroyed

Kind: global function
Returns: Array - of age destroyed values.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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(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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

SAN_DAILY_CLOSING_PRICE(projectSlug, day) ⇒ number

Returns the closing price for a given day.

Kind: global function
Returns: number - closing price.
Customfunction:

Param Type Description
projectSlug string Name 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).
day date The date to fetch the data. Example: DATE(2018, 9, 20)

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

SAN_EMERGING_TRENDS(size, from, to) ⇒ Array

Returns list of emerging trends and their corresponding trend score.

Kind: global function
Returns: Array - of trending words and their score.
Customfunction:

Param Type Description
size number An integer showing how many words should be included in the top list (max 100).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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(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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
limit number The limit of transactions to be shown.
transactionType string Available transaction types: ALL, IN, OUT

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

Returns the exchange balance.

Kind: global function
Returns: Array - of exchange balances.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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

Returns the exchange balance.

Kind: global function
Returns: number - of aggregated exchange balances.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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

Returns the exchange inflow.

Kind: global function
Returns: Array - of exchange inflows.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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

Returns the exchange inflow.

Kind: global function
Returns: number - of aggregated exchange inflows.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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

Returns the exchange outflow.

Kind: global function
Returns: Array - of exchange outflows.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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

Returns the exchange outflow.

Kind: global function
Returns: number - of aggregated exchange outflows.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

SAN_FUNCTIONS() ⇒ Array

Returns all available functions.

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

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
address string ERC20 or ETH address.

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
address string ERC20 or ETH address.

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
balance string "total" Interval 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-inf", "total"
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
balance string "total" Interval 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-inf", "total"
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
balance string "total" Interval 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-inf", "total"
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
balance string "total" Interval 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-inf", "total"
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Description
projectSlug string Name 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).
currency string The currency in which the data should be presented. Either "USD" or "BTC".

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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

Returns the token's mean age.

Kind: global function
Returns: Array - of mean age values.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
timeBound string The metric is calculated only by taking into account the tokens/coins that have moved in the past number of years or days.
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
timeBound string The metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
timeBound string The metric is calculated only by taking into account the tokens/coins that have moved in the past number of years or days.
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
timeBound string The metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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

Returns the token's network growth

Kind: global function
Returns: Array - of network growth.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Description
currency string The currency in which the data should be presented. Either "USD" or "BTC".
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

SAN_PROJECT_FUNDAMENTALS(projectSlug) ⇒ Array

Fetch fundamentals for a specified project.

Kind: global function
Returns: Array - of project details.
Customfunction:

Param Type Description
projectSlug string Name 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_PROJECT_SOCIAL_DATA(projectSlug) ⇒ Array

Returns social data for a specified project.

Kind: global function
Returns: Array - of project's social data.
Customfunction:

Param Type Description
projectSlug string Name 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(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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
timeBound string The metric is calculated only by taking into account the tokens/coins that have moved in the past number of years or days.
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
currency string The metric is calculated using a currency of choice. Available currencies: USD
timeBound string The metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

SAN_REVERSE(array) ⇒ Array

Returns the reversed array of the results

Kind: global function
Returns: Array - of reversed results
Customfunction:

Param Type Description
array Array The array of results

SAN_SOCIAL_DOMINANCE(projectSlug, from, to, source) ⇒ Array

Returns the % of the social dominance a given project has over time in a given social channel.

Kind: global function
Returns: Array - of dominance.
Customfunction:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
source string The source, which the dominance is calculated from. Sources are: ALL, TELEGRAM, REDDIT

SAN_SOCIAL_VOLUME(projectSlug, from, to, source, interval) ⇒ Array

Returns the social volume for a slug.

Kind: global function
Returns: Array - of the slug's social volume.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
source string The source of mention counts, one of the following: "TELEGRAM_CHATS_OVERVIEW", "TELEGRAM_DISCUSSION_OVERVIEW", "TWITTER_CHATS_OVERVIEW", "REDDIT_COMMENTS_OVERVIEW", "TOTAL"
interval string "1d" The resolution with which the data is fetched. Example: "5m"

SAN_SOCIAL_VOLUME_AGGREGATED(projectSlug, from, to, source, aggregation) ⇒ number

Returns the social volume for a slug.

Kind: global function
Returns: number - of aggregated the slug's social volume.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
source string The source of mention counts, one of the following: "TELEGRAM_CHATS_OVERVIEW", "TELEGRAM_DISCUSSION_OVERVIEW", "TWITTER_CHATS_OVERVIEW", "REDDIT_COMMENTS_OVERVIEW", "TOTAL"
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

SAN_SOCIAL_VOLUME_PROJECTS() ⇒ Array

Returns a list of project slugs for which there is social volume data.

Kind: global function
Returns: Array - of social volume projects.
Customfunction:

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
timeBound string The metric is calculated only by taking into account the tokens/coins that have moved in the past number of years or days.
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
timeBound string The metric is calculated only by taking into account the tokens/coins that have moved in the past number of years/days.
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
limit number The limit of transactions to be shown.

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
numberOfHolders number Take top number of holders into account when calculating.

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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

Returns the token's velocity.

Kind: global function
Returns: Array - of token velocity values.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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

Returns the token's velocity.

Kind: global function
Returns: number - of aggregated token velocity values.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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

Returns the slug's trading volume.

Kind: global function
Returns: Array - of the slug's trading volume.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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

Returns the slug's trading volume.

Kind: global function
Returns: number - of aggregated the slug's trading volume.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

SAN_WEIGHTED_SOCIAL_SENTIMENT(projectSlug, from, to, source, interval) ⇒ Array

Returns the weighted social sentiment for a slug.

Kind: global function
Returns: Array - of the slug's weighted social sentiment.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
source string The source of mention counts, one of the following: "TELEGRAM_CHATS_OVERVIEW", "TELEGRAM_DISCUSSION_OVERVIEW", "TWITTER_CHATS_OVERVIEW", "REDDIT_COMMENTS_OVERVIEW", "TOTAL"
interval string "1d" The resolution with which the data is fetched. Example: "5m"

SAN_WEIGHTED_SOCIAL_SENTIMENT_AGGREGATED(projectSlug, from, to, source, aggregation) ⇒ number

Returns the weighted social sentiment for a slug.

Kind: global function
Returns: number - of aggregated the slug's weighted social sentiment.
Customfunction:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
source string The source of mention counts, one of the following: "TELEGRAM_CHATS_OVERVIEW", "TELEGRAM_DISCUSSION_OVERVIEW", "TWITTER_CHATS_OVERVIEW", "REDDIT_COMMENTS_OVERVIEW", "TOTAL"
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
interval string "1d" The resolution with which the data is fetched. Example: "5m"

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:

Param Type Default Description
projectSlug string Name 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).
from date The starting date to fetch the data. Example: DATE(2018, 9, 20)
to date The ending date to fetch the data. Example: DATE(2018, 9, 21)
aggregation string "null" Aggregation for the timeseries metrics. Example: "LAST"