Functions we offer
Santiment Team
Nov 04, 2019- SANACTIVEADDRESSES
- SANACTIVEDEPOSITS
- SANAGEDESTROYED
- SANALLPROJECTS
- SANDAILYAVG_MARKETCAP
- SANDAILYCLOSING_MARKETCAP
- SANDAILYCLOSING_PRICE
- SANDEVACTIVITY
- SANEMERGINGTRENDS
- SANERC20PROJECTS
- SANETHSPENTOVERTIME
- SANETHTOP_TRANSACTIONS
- SANEXCHANGEBALANCE
- SANEXCHANGEFUNDS_FLOW
- SANEXCHANGEINFLOW
- SANEXCHANGEOUTFLOW
- SAN_FUNCTIONS
- SANGASUSED
- SANGITHUBACTIVITY
- SANHISTORICALBALANCE
- SANHISTORYTWITTER_DATA
- SANLATESTPRICE
- SANMEANAGE
- SANMEANREALIZED_PRICE
- SANMINERSBALANCE
- SANMININGPOOLS_DISTRIBUTION
- SANMVRVLONGSHORTDIFF
- SANMVRVRATIO
- SANNETWORKGROWTH
- SAN_NEWS
- SANNVTRATIO
- SAN_OHLC
- SANPRICEABSOLUTE_CHANGE
- SANPRICEPERCENT_CHANGE
- SANPRICEVOLUME_DIFF
- SAN_PRICES
- SANPROJECTFUNDAMENTALS
- SANPROJECTSOCIAL_DATA
- SANREALIZEDVALUE
- SANSOCIALDOMINANCE
- SANSOCIALVOLUME
- SANSOCIALVOLUME_PROJECTS
- SANTOKENAGE_CONSUMED
- SANTOKENCIRCULATION
- SANTOKENTOP_TRANSACTIONS
- SANTOPHOLDERSPERCENTOFTOTALSUPPLY
- SANTRANSACTIONVOLUME
- SAN_VELOCITY
SAN_ACTIVE_ADDRESSES
SAN_ACTIVE_ADDRESSES(projectSlug, from, to) ⇒ 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 daily active addresses 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_ACTIVE_DEPOSITS
SAN_ACTIVE_DEPOSITS(projectSlug, from, to) ⇒ 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 | 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_AGE_DESTROYED
SAN_AGE_DESTROYED(projectSlug, from, to) ⇒ Array
Returns the token's age destroyed
- Kind: global function
- Returns:
Array- of age destroyed 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_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_DAILY_AVG_MARKETCAP
SAN_DAILY_AVG_MARKETCAP(projectSlug, from, to, currency) ⇒ Array
Returns the daily average marketcap.
- Kind: global function
- Returns:
Array- of daily average marketcaps. - 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) |
| currency | string | The metric is calculated using a currency of choice. Available currencies: USD |
SAN_DAILY_CLOSING_MARKETCAP
SAN_DAILY_CLOSING_MARKETCAP(projectSlug, from, to, currency) ⇒ Array
Returns the daily closing marketcap.
- Kind: global function
- Returns:
Array- of daily closing marketcaps. - 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) |
| currency | string | The metric is calculated using a currency of choice. Available currencies: USD |
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:
| 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
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
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
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:
| 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
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
SAN_EXCHANGE_BALANCE(projectSlug, from, to) ⇒ Array
Returns the exchange balance.
- Kind: global function
- Returns:
Array- of exchange 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_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:
| 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
SAN_EXCHANGE_INFLOW(projectSlug, from, to) ⇒ Array
Returns the exchange inflow.
- Kind: global function
- Returns:
Array- of exchange inflows. - 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_OUTFLOW
SAN_EXCHANGE_OUTFLOW(projectSlug, from, to) ⇒ Array
Returns the exchange outflow.
- Kind: global function
- Returns:
Array- of exchange outflows. - 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_FUNCTIONS
SAN_FUNCTIONS() ⇒ Array
Returns all available functions.
- Kind: global function
- Returns:
Array- of function names. - Customfunction:
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:
| 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
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
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_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:
| 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_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:
| 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_MEAN_AGE
SAN_MEAN_AGE(projectSlug, from, to) ⇒ Array
Returns the token's mean age.
- Kind: global function
- Returns:
Array- of mean age 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_MEAN_REALIZED_PRICE
SAN_MEAN_REALIZED_PRICE(projectSlug, from, to, currency, timeBound) ⇒ Array
Returns the mean realized price.
- Kind: global function
- Returns:
Array- of mean realized prices. - 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) |
| 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 coins/tokens that have moved in the past number of years or days. |
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:
| 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
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
SAN_MVRV_LONG_SHORT_DIFF(projectSlug, from, to, currency) ⇒ Array
Returns the difference between MVRV.
- Kind: global function
- Returns:
Array- of MVRV 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) |
| currency | string | The metric is calculated using a currency of choice. Available currencies: USD |
SAN_MVRV_RATIO
SAN_MVRV_RATIO(projectSlug, from, to, currency, timeBound) ⇒ Array
Returns MVRV(Market-Value-to-Realized-Value).
- Kind: global function
- Returns:
Array- of MVRV 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) |
| 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 coins/tokens that have moved in the past number of years or days. |
SAN_NETWORK_GROWTH
SAN_NETWORK_GROWTH(projectSlug, from, to) ⇒ Array
Returns the number of new addresses being created on the project network for a given slug and time interval.
- Kind: global function
- Returns:
Array- of number of new addresses. - 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_NEWS
SAN_NEWS(tag, from, to, size) ⇒ Array
Returns the news for given word
- Kind: global function
- Returns:
Array- of news. - Customfunction:
| Param | Type | Description |
|---|---|---|
| tag | string | Project name, ticker or other crypto related words. |
| 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) |
| size | number | Size limit of the returned results. Default is 10. |
SAN_NVT_RATIO
SAN_NVT_RATIO(projectSlug, from, to) ⇒ Array
Returns NVT (Network-Value-to-Transactions-Ratio Daily Market Cap / Daily Transaction Volume) Since Daily Transaction Volume gets rather noisy and easy to manipulate by transferring the same tokens through couple of addresses over and over again, it’s not an ideal measure of a network’s economic activity. That’s why we calculate NVT using Daily Trx Volume, but also by using Daily Token Circulation instead, which filters out excess transactions and provides a cleaner overview of a blockchain’s daily transaction throughput.
- Kind: global function
- Returns:
Array- of NVT - 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_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:
| 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_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:
| 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_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:
| 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_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:
| 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
SAN_PRICES(projectSlug, from, to) ⇒ Array
Returns the prices for the specified asset, during a given time interval.
- Kind: global function
- Returns:
Array- of prices. - 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_PROJECT_FUNDAMENTALS
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
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
SAN_REALIZED_VALUE(projectSlug, from, to, currency, timeBound) ⇒ 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 | 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 coins/tokens that have moved in the past number of years or days. |
SAN_SOCIAL_DOMINANCE
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, DISCORD, PROFESSIONAL_TRADERS_CHAT |
SAN_SOCIAL_VOLUME
SAN_SOCIAL_VOLUME(projectSlug, from, to, socialVolumeType) ⇒ Array
Returns a list of mentions count for a given project and time interval.
- Kind: global function
- Returns:
Array- of mention counts. - 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) |
| socialVolumeType | string | The source of mention counts, one of the following: "PROFESSIONAL_TRADERS_CHAT_OVERVIEW", "TELEGRAM_CHATS_OVERVIEW", "TELEGRAM_DISCUSSION_OVERVIEW", "DISCORD_DISCUSSION_OVERVIEW" |
SAN_SOCIAL_VOLUME_PROJECTS
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
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
SAN_TOKEN_CIRCULATION(projectSlug, from, to, timeBound) ⇒ Array
Returns token circulation for a given slug and time interval.
- Kind: global function
- Returns:
Array- of token circulation 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) |
| timeBound | string | The metric is calculated only by taking into account the coins/tokens that have moved in the past number of years or days. |
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:
| 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_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:
| 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
SAN_TRANSACTION_VOLUME(projectSlug, from, to) ⇒ 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 | 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_VELOCITY
SAN_VELOCITY(projectSlug, from, to) ⇒ Array
Returns the token's velocity.
- Kind: global function
- Returns:
Array- of token velocity 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) |