- 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_24H_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_60D(projectSlug, from, to, interval) ⇒
Array Returns the active addresses in the last 60 days.
- SAN_ACTIVE_ADDRESSES_60D_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the active addresses in the last 60 days.
- SAN_ACTIVE_ADDRESSES_60D_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the active addresses in the last 60 days.
- SAN_ACTIVE_ADDRESSES_90D(projectSlug, from, to, interval) ⇒
Array Returns the active addresses in the last 90 days.
- SAN_ACTIVE_ADDRESSES_90D_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the active addresses in the last 90 days.
- SAN_ACTIVE_ADDRESSES_90D_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the active addresses in the last 90 days.
- 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_ADDRESSES_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_ACTIVE_DEPOSITS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_AGE_DESTROYED_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_CONTRACT_FUNDING_RATE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_BITMEX_PERPETUAL_OPEN_INTEREST_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_ASSETS_ISSUED(projectSlug, from, to, interval) ⇒
Array Returns the daily issued assets.
- SAN_DAILY_ASSETS_ISSUED_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the daily issued assets.
- SAN_DAILY_ASSETS_ISSUED_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the daily issued assets.
- 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_AVG_MARKETCAP_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒
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_MARKETCAP_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒
number Returns the daily closing marketcap.
- SAN_DAILY_CLOSING_PRICE(projectSlug, day) ⇒
number Returns the closing price for a given day.
- SAN_DAILY_DEPOSIT_TRANSACTIONS(projectSlug, from, to, interval) ⇒
Array Returns number of withdrawal transactions.
- SAN_DAILY_DEPOSIT_TRANSACTIONS_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns number of withdrawal transactions.
- SAN_DAILY_DEPOSIT_TRANSACTIONS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns number of withdrawal transactions.
- SAN_DAILY_TRUSTLINES_COUNT_CHANGE(projectSlug, from, to, interval) ⇒
Array Returns the daily trustlines count change.
- SAN_DAILY_TRUSTLINES_COUNT_CHANGE_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the daily trustlines count change.
- SAN_DAILY_TRUSTLINES_COUNT_CHANGE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the daily trustlines count change.
- SAN_DAILY_WITHDRAWAL_TRANSACTIONS(projectSlug, from, to, interval) ⇒
Array Returns number of withdrawal transactions.
- SAN_DAILY_WITHDRAWAL_TRANSACTIONS_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns number of withdrawal transactions.
- SAN_DAILY_WITHDRAWAL_TRANSACTIONS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns number of withdrawal transactions.
- SAN_DEPOSIT_TRANSACTIONS_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒
Array Returns the deposit transactions for a slug in a specific exchange
- SAN_DEPOSIT_TRANSACTIONS_INTRADAY(projectSlug, from, to, interval) ⇒
Array Returns number of withdrawal transactions with the option of smaller intervals.
- SAN_DEPOSIT_TRANSACTIONS_INTRADAY_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns number of withdrawal transactions with the option of smaller intervals.
- SAN_DEPOSIT_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns number of withdrawal transactions with the option of smaller intervals.
- SAN_DEV_ACTIVITY(projectSlug, from, to) ⇒
Array Returns a list of dev activity for a given slug and time interval.
- SAN_DEX_VOLUME_IN_USD_INTRADAY(projectSlug, from, to, interval) ⇒
Array Returns the DEX volume in USD.
- SAN_DEX_VOLUME_IN_USD_INTRADAY_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the DEX volume in USD.
- SAN_DEX_VOLUME_IN_USD_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the DEX volume in USD.
- SAN_DEX_VOLUME_IN_XRP_INTRADAY(projectSlug, from, to, interval) ⇒
Array Returns the DEX volume in XRP.
- SAN_DEX_VOLUME_IN_XRP_INTRADAY_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the DEX volume in XRP.
- SAN_DEX_VOLUME_IN_XRP_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the DEX volume in XRP.
- 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_BALANCE_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒
Array Returns the exchange balance for a slug in a specific exchange
- SAN_EXCHANGE_BALANCE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_INFLOW_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒
Array Returns the exchange inflow for a slug in a specific exchange
- SAN_EXCHANGE_INFLOW_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_OUTFLOW_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒
Array Returns the exchange outflow for a slug in a specific exchange
- SAN_EXCHANGE_OUTFLOW_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_EXCHANGE_PERCENT_OF_SUPPLY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns exchange percent of total supply.
- SAN_FUNCTIONS() ⇒
Array Returns all available functions.
- SAN_FUNDING_RATE_BUSD(projectSlug, from, to, fundingRateExchange, interval) ⇒
Array Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
- SAN_FUNDING_RATE_BUSD_AGGREGATED(projectSlug, from, to, fundingRateExchange, aggregation) ⇒
number Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
- SAN_FUNDING_RATE_BUSD_MULTIPLE_SLUGS(projectSlugsList, from, to, fundingRateExchange, interval) ⇒
number Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
- SAN_FUNDING_RATE_USDT(projectSlug, from, to, fundingRateExchange, interval) ⇒
Array Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
- SAN_FUNDING_RATE_USDT_AGGREGATED(projectSlug, from, to, fundingRateExchange, aggregation) ⇒
number Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
- SAN_FUNDING_RATE_USDT_MULTIPLE_SLUGS(projectSlugsList, from, to, fundingRateExchange, interval) ⇒
number Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
- 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_HOLDERS_DISTRIBUTION_COMBINED_BALANCE_MULTIPLE_SLUGS(projectSlugsList, from, to, balance, interval) ⇒
number Returns the number of tokens in a specific bucket.
- SAN_HOLDERS_DISTRIBUTION_MULTIPLE_SLUGS(projectSlugsList, from, to, balance, interval) ⇒
number Represents the total number of addresses holding the given amount of tokens.
- 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_MARKETCAP_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒
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_AGE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_DOLLAR_INVESTED_AGE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_MEAN_REALIZED_PRICE_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, timeBound, interval) ⇒
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_LONG_SHORT_DIFF_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒
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_MVRV_RATIO_INTRADAY(projectSlug, from, to, timeBound, interval) ⇒
Array Returns MVRV(Market-Value-to-Realized-Value) with the option of smaller intervals.
- SAN_MVRV_RATIO_INTRADAY_AGGREGATED(projectSlug, from, to, timeBound, aggregation) ⇒
number Returns MVRV(Market-Value-to-Realized-Value) with the option of smaller intervals.
- SAN_MVRV_RATIO_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, timeBound, interval) ⇒
number Returns MVRV(Market-Value-to-Realized-Value) with the option of smaller intervals.
- SAN_MVRV_RATIO_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, timeBound, interval) ⇒
number Returns MVRV(Market-Value-to-Realized-Value).
- SAN_MVRV_Z_SCORE(projectSlug, from, to, interval) ⇒
Array Returns the MVRV Z score.
- SAN_MVRV_Z_SCORE_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the MVRV Z score.
- SAN_MVRV_Z_SCORE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the MVRV Z score.
- 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_GROWTH_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_NETWORK_PROFIT_LOSS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_NVT_RATIO_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒
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_REALIZED_VALUE_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, timeBound, interval) ⇒
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, interval) ⇒
Array Returns the social dominance for a slug.
- SAN_SOCIAL_DOMINANCE_AGGREGATED(projectSlug, from, to, source, aggregation) ⇒
number Returns the social dominance for a slug.
- SAN_SOCIAL_DOMINANCE_MULTIPLE_SLUGS(projectSlugsList, from, to, source, interval) ⇒
number Returns the social dominance for a slug.
- 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_MULTIPLE_SLUGS(projectSlugsList, from, to, source, interval) ⇒
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_CIRCULATION_MULTIPLE_SLUGS(projectSlugsList, from, to, timeBound, interval) ⇒
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_TOTAL_ASSETS_ISSUED(projectSlug, from, to, interval) ⇒
Array Returns the total issued assets.
- SAN_TOTAL_ASSETS_ISSUED_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the total issued assets.
- SAN_TOTAL_ASSETS_ISSUED_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the total issued assets.
- SAN_TOTAL_TRUSTLINES_COUNT(projectSlug, from, to, interval) ⇒
Array Returns the total trustlines count.
- SAN_TOTAL_TRUSTLINES_COUNT_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the total trustlines count.
- SAN_TOTAL_TRUSTLINES_COUNT_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the total trustlines count.
- SAN_TRADING_VOLUME(projectSlug, from, to, currency, interval) ⇒
Array Returns the slug's trading volume.
- SAN_TRADING_VOLUME_AGGREGATED(projectSlug, from, to, currency, aggregation) ⇒
number Returns the slug's trading volume.
- SAN_TRADING_VOLUME_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, interval) ⇒
number Returns the slug's trading volume.
- SAN_TRANSACTION_VOLUME(projectSlug, from, to, interval) ⇒
Array Gets the transaction volume for the specified asset, during a given time interval. Transaction Volume" refers to the total number of tokens within all transfers that have occurred on a blockchain.
- 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_TRANSACTION_VOLUME_LOSS(projectSlug, from, to, interval) ⇒
Array Returns the transaction volume in loss.
- SAN_TRANSACTION_VOLUME_LOSS_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the transaction volume in loss.
- SAN_TRANSACTION_VOLUME_LOSS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the transaction volume in loss.
- SAN_TRANSACTION_VOLUME_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
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_TRANSACTION_VOLUME_PROFIT(projectSlug, from, to, interval) ⇒
Array Returns the transaction volume in profit.
- SAN_TRANSACTION_VOLUME_PROFIT_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the transaction volume in profit.
- SAN_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO(projectSlug, from, to, interval) ⇒
Array Returns the ratio between transaction volume in profit and transaction volume in loss.
- SAN_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the ratio between transaction volume in profit and transaction volume in loss.
- SAN_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the ratio between transaction volume in profit and transaction volume in loss.
- SAN_TRANSACTION_VOLUME_PROFIT_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the transaction volume in profit.
- SAN_TRANSACTIONS_COUNT(projectSlug, from, to, interval) ⇒
Array Returns the transactions count.
- SAN_TRANSACTIONS_COUNT_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the transactions count.
- SAN_TRANSACTIONS_COUNT_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the transactions count.
- 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_VELOCITY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the token's velocity.
- SAN_VOLUME(projectSlug, from, to, interval) ⇒
Array Returns the slug's transaction volume.
- SAN_VOLUME_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns the slug's transaction volume.
- SAN_VOLUME_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the slug's transaction 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_WEIGHTED_SOCIAL_SENTIMENT_MULTIPLE_SLUGS(projectSlugsList, from, to, source, interval) ⇒
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_WHALE_TRANSACTION_COUNT_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns the number of transactions transferring more than 100k USD.
- SAN_WITHDRAWAL_TRANSACTIONS_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒
Array Returns the withdrawal transactions for a slug in a specific exchange
- SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY(projectSlug, from, to, interval) ⇒
Array Returns number of withdrawal transactions with the option of smaller intervals.
- SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_AGGREGATED(projectSlug, from, to, aggregation) ⇒
number Returns number of withdrawal transactions with the option of smaller intervals.
- SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒
number Returns number of withdrawal transactions with the option of smaller intervals.
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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 results for multiple slugs
active addresses for the last 24 hours.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the active addresses in the last 60 days.
Kind: global function
Returns: Array - of the active addresses in the last 60 days.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the active addresses in the last 60 days.
Kind: global function
Returns: number - of aggregated the active addresses in the last 60 days.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the active addresses in the last 60 days.
Kind: global function
Returns: number - of results for multiple slugs
the active addresses in the last 60 days.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the active addresses in the last 90 days.
Kind: global function
Returns: Array - of the active addresses in the last 90 days.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the active addresses in the last 90 days.
Kind: global function
Returns: number - of aggregated the active addresses in the last 90 days.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the active addresses in the last 90 days.
Kind: global function
Returns: number - of results for multiple slugs
the active addresses in the last 90 days.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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 results for multiple slugs
active addresses.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns number of unique deposit addresses that have been active for a project.
Kind: global function
Returns: number - of results for multiple slugs
deposit address numbers.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the token's age destroyed
Kind: global function
Returns: number - of results for multiple slugs
age destroyed values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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:
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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_CONTRACT_FUNDING_RATE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ 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 results for multiple slugs
the funding rates that are paid by one of the sides of the perpetual contract to the other
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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 results for multiple slugs
the amount of open perpetual contracts.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the daily issued assets.
Kind: global function
Returns: Array - of the daily issued assets.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the daily issued assets.
Kind: global function
Returns: number - of aggregated the daily issued assets.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the daily issued assets.
Kind: global function
Returns: number - of results for multiple slugs
the daily issued assets.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the daily average marketcap.
Kind: global function
Returns: number - of results for multiple slugs
daily average marketcaps.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the daily closing marketcap.
Kind: global function
Returns: number - of results for multiple slugs
daily closing marketcaps.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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) |
Returns number of withdrawal transactions.
Kind: global function
Returns: Array - of number of withdrawal transactions.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns number of withdrawal transactions.
Kind: global function
Returns: number - of aggregated number of withdrawal transactions.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns number of withdrawal transactions.
Kind: global function
Returns: number - of results for multiple slugs
number of withdrawal transactions.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the daily trustlines count change.
Kind: global function
Returns: Array - of the daily trustlines count change.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the daily trustlines count change.
Kind: global function
Returns: number - of aggregated the daily trustlines count change.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the daily trustlines count change.
Kind: global function
Returns: number - of results for multiple slugs
the daily trustlines count change.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns number of withdrawal transactions.
Kind: global function
Returns: Array - of number of withdrawal transactions.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns number of withdrawal transactions.
Kind: global function
Returns: number - of aggregated number of withdrawal transactions.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns number of withdrawal transactions.
Kind: global function
Returns: number - of results for multiple slugs
number of withdrawal transactions.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the deposit transactions for a slug in a specific exchange
Kind: global function
Returns: Array - exchange inflow values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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) | |
| owner | string |
Name of the exchange | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns number of withdrawal transactions with the option of smaller intervals.
Kind: global function
Returns: Array - of number of withdrawal transactions with the option of smaller intervals.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns number of withdrawal transactions with the option of smaller intervals.
Kind: global function
Returns: number - of aggregated number of withdrawal transactions with the option of smaller intervals.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns number of withdrawal transactions with the option of smaller intervals.
Kind: global function
Returns: number - of results for multiple slugs
number of withdrawal transactions with the option of smaller intervals.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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) |
Returns the DEX volume in USD.
Kind: global function
Returns: Array - of the DEX volume in USD.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the DEX volume in USD.
Kind: global function
Returns: number - of aggregated the DEX volume in USD.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the DEX volume in USD.
Kind: global function
Returns: number - of results for multiple slugs
the DEX volume in USD.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the DEX volume in XRP.
Kind: global function
Returns: Array - of the DEX volume in XRP.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the DEX volume in XRP.
Kind: global function
Returns: number - of aggregated the DEX volume in XRP.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the DEX volume in XRP.
Kind: global function
Returns: number - of results for multiple slugs
the DEX volume in XRP.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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) |
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:
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) |
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 |
Returns the exchange balance.
Kind: global function
Returns: Array - of exchange balances.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the exchange balance.
Kind: global function
Returns: number - of aggregated exchange balances.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the exchange balance for a slug in a specific exchange
Kind: global function
Returns: Array - exchange inflow values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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) | |
| owner | string |
Name of the exchange | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns the exchange balance.
Kind: global function
Returns: number - of results for multiple slugs
exchange balances.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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) |
Returns the exchange inflow.
Kind: global function
Returns: Array - of exchange inflows.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the exchange inflow.
Kind: global function
Returns: number - of aggregated exchange inflows.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the exchange inflow for a slug in a specific exchange
Kind: global function
Returns: Array - exchange inflow values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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) | |
| owner | string |
Name of the exchange | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns the exchange inflow.
Kind: global function
Returns: number - of results for multiple slugs
exchange inflows.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the exchange outflow.
Kind: global function
Returns: Array - of exchange outflows.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the exchange outflow.
Kind: global function
Returns: number - of aggregated exchange outflows.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the exchange outflow for a slug in a specific exchange
Kind: global function
Returns: Array - exchange inflow values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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) | |
| owner | string |
Name of the exchange | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns the exchange outflow.
Kind: global function
Returns: number - of results for multiple slugs
exchange outflows.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns exchange percent of total supply.
Kind: global function
Returns: number - of results for multiple slugs
exchange percent of total supply.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns all available functions.
Kind: global function
Returns: Array - of function names.
Customfunction:
Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
Kind: global function
Returns: Array - of the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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) | |
| fundingRateExchange | string |
The exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" "FTX" "DYDX" "BITFINEX" "DERIBIT" | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
Kind: global function
Returns: number - of aggregated the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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) | |
| fundingRateExchange | string |
The exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" | |
| aggregation | string |
"null" |
Aggregation for the timeseries metrics. Example: "LAST" |
SAN_FUNDING_RATE_BUSD_MULTIPLE_SLUGS(projectSlugsList, from, to, fundingRateExchange, interval) ⇒ number
Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
Kind: global function
Returns: number - of results for multiple slugs
the funding rates that are paid by one of the sides of the perpetual contract to the other (BUSD).
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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) | |
| fundingRateExchange | string |
The exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
Kind: global function
Returns: Array - of the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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) | |
| fundingRateExchange | string |
The exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" "FTX" "DYDX" "BITFINEX" "DERIBIT" | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
Kind: global function
Returns: number - of aggregated the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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) | |
| fundingRateExchange | string |
The exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" | |
| aggregation | string |
"null" |
Aggregation for the timeseries metrics. Example: "LAST" |
SAN_FUNDING_RATE_USDT_MULTIPLE_SLUGS(projectSlugsList, from, to, fundingRateExchange, interval) ⇒ number
Returns the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
Kind: global function
Returns: number - of results for multiple slugs
the funding rates that are paid by one of the sides of the perpetual contract to the other (USDT).
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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) | |
| fundingRateExchange | string |
The exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
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) |
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) |
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. |
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. |
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) |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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-100M", "100M-1B", "1B-inf", "total" |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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-100M", "100M-1B", "1B-inf", "total" |
| aggregation | string |
"null" |
Aggregation for the timeseries metrics. Example: "LAST" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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-100M", "100M-1B", "1B-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, more info at https://academy.santiment.net/glossary/#slug. Example: "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-100M", "100M-1B", "1B-inf", "total" |
| aggregation | string |
"null" |
Aggregation for the timeseries metrics. Example: "LAST" |
SAN_HOLDERS_DISTRIBUTION_COMBINED_BALANCE_MULTIPLE_SLUGS(projectSlugsList, from, to, balance, interval) ⇒ number
Returns the number of tokens in a specific bucket.
Kind: global function
Returns: number - of results for multiple slugs
the number of tokens in a specific bucket.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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-100M", "100M-1B", "1B-inf", "total" |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Represents the total number of addresses holding the given amount of tokens.
Kind: global function
Returns: number - of results for multiple slugs
total number of addresses holding the given amount of tokens.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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-100M", "100M-1B", "1B-inf", "total" |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
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". |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the marketcap for a slug.
Kind: global function
Returns: number - of results for multiple slugs
the slug's marketcap.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the token's mean age.
Kind: global function
Returns: number - of results for multiple slugs
mean age values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the token's mean dollar invested age.
Kind: global function
Returns: number - of results for multiple slugs
mean dollar invested age values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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, more info at https://academy.santiment.net/glossary/#slug. Example: "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_MEAN_REALIZED_PRICE_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, timeBound, interval) ⇒ number
Returns the mean realized price.
Kind: global function
Returns: number - of results for multiple slugs
mean realized prices.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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. | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
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) |
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) |
Returns the difference between MVRV.
Kind: global function
Returns: Array - of MVRV differences.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the difference between MVRV.
Kind: global function
Returns: number - of results for multiple slugs
MVRV differences.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns MVRV(Market-Value-to-Realized-Value) with the option of smaller intervals.
Kind: global function
Returns: Array - of MVRV ratios with the option of smaller intervals.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns MVRV(Market-Value-to-Realized-Value) with the option of smaller intervals.
Kind: global function
Returns: number - of aggregated MVRV ratios with the option of smaller intervals.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns MVRV(Market-Value-to-Realized-Value) with the option of smaller intervals.
Kind: global function
Returns: number - of results for multiple slugs
MVRV ratios with the option of smaller intervals.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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. | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns MVRV(Market-Value-to-Realized-Value).
Kind: global function
Returns: number - of results for multiple slugs
MVRV ratios.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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. | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns the MVRV Z score.
Kind: global function
Returns: Array - of the MVRV Z score.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the MVRV Z score.
Kind: global function
Returns: number - of aggregated the MVRV Z score.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the MVRV Z score.
Kind: global function
Returns: number - of results for multiple slugs
the MVRV Z score.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the token's network growth
Kind: global function
Returns: number - of results for multiple slugs
network growth.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the network's profit/loss.
Kind: global function
Returns: number - of results for multiple slugs
the network's profit/loss.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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 results for multiple slugs
NVT ratios
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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) |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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) |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the prices for the slug in the given time period.
Kind: global function
Returns: number - of results for multiple slugs
the prices for the slug in the given time period.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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) |
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" |
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) |
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" |
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). |
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). |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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_REALIZED_VALUE_MULTIPLE_SLUGS(projectSlugsList, from, to, currency, timeBound, interval) ⇒ 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 results for multiple slugs
realized values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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. | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
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 |
Returns the social dominance for a slug.
Kind: global function
Returns: Array - of the slug's social dominance.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the social dominance for a slug.
Kind: global function
Returns: number - of aggregated the slug's social dominance.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the social dominance for a slug.
Kind: global function
Returns: number - of results for multiple slugs
the slug's social dominance.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the social volume for a slug.
Kind: global function
Returns: number - of results for multiple slugs
the slug's social volume.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns a list of project slugs for which there is social volume data.
Kind: global function
Returns: Array - of social volume projects.
Customfunction:
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) |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns token circulation for a given slug and time interval.
Kind: global function
Returns: number - of results for multiple slugs
token circulation values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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. | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
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. |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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. |
Returns the total issued assets.
Kind: global function
Returns: Array - of the total issued assets.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the total issued assets.
Kind: global function
Returns: number - of aggregated the total issued assets.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the total issued assets.
Kind: global function
Returns: number - of results for multiple slugs
the total issued assets.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the total trustlines count.
Kind: global function
Returns: Array - of the total trustlines count.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the total trustlines count.
Kind: global function
Returns: number - of aggregated the total trustlines count.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the total trustlines count.
Kind: global function
Returns: number - of results for multiple slugs
the total trustlines count.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the slug's trading volume.
Kind: global function
Returns: Array - of the slugs's trading volume.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the slug's trading volume.
Kind: global function
Returns: number - of aggregated the slugs's trading volume.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the slug's trading volume.
Kind: global function
Returns: number - of results for multiple slugs
the slugs's trading volume.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the transaction volume in loss.
Kind: global function
Returns: Array - of the transaction volume in loss.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the transaction volume in loss.
Kind: global function
Returns: number - of aggregated the transaction volume in loss.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the transaction volume in loss.
Kind: global function
Returns: number - of results for multiple slugs
the transaction volume in loss.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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 results for multiple slugs
transaction volumes.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the transaction volume in profit.
Kind: global function
Returns: Array - of the transaction volume in profit.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the transaction volume in profit.
Kind: global function
Returns: number - of aggregated the transaction volume in profit.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the ratio between transaction volume in profit and transaction volume in loss.
Kind: global function
Returns: Array - of the ratio between transaction volume in profit and transaction volume in loss.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the ratio between transaction volume in profit and transaction volume in loss.
Kind: global function
Returns: number - of aggregated the ratio between transaction volume in profit and transaction volume in loss.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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_TRANSACTION_VOLUME_PROFIT_LOSS_RATIO_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ number
Returns the ratio between transaction volume in profit and transaction volume in loss.
Kind: global function
Returns: number - of results for multiple slugs
the ratio between transaction volume in profit and transaction volume in loss.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the transaction volume in profit.
Kind: global function
Returns: number - of results for multiple slugs
the transaction volume in profit.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the transactions count.
Kind: global function
Returns: Array - of the transactions count.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the transactions count.
Kind: global function
Returns: number - of aggregated the transactions count.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the transactions count.
Kind: global function
Returns: number - of results for multiple slugs
the transactions count.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the token's velocity.
Kind: global function
Returns: number - of results for multiple slugs
token velocity values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the slug's transaction volume.
Kind: global function
Returns: Array - of the slug's transaction volume.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the slug's transaction volume.
Kind: global function
Returns: number - of aggregated the slug's transaction volume.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the slug's transaction volume.
Kind: global function
Returns: number - of results for multiple slugs
the slug's transaction volume.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the weighted social sentiment for a slug.
Kind: global function
Returns: number - of results for multiple slugs
the slug's weighted social sentiment.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
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, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns the number of transactions transferring more than 100k USD.
Kind: global function
Returns: number - of results for multiple slugs
the number of transactions transferring more than 100k USD.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |
Returns the withdrawal transactions for a slug in a specific exchange
Kind: global function
Returns: Array - exchange inflow values.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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) | |
| owner | string |
Name of the exchange | |
| interval | string |
"1d" |
The resolution with which the data is fetched. Example: "5m" |
Returns number of withdrawal transactions with the option of smaller intervals.
Kind: global function
Returns: Array - of number of withdrawal transactions with the option of smaller intervals.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns number of withdrawal transactions with the option of smaller intervals.
Kind: global function
Returns: number - of aggregated number of withdrawal transactions with the option of smaller intervals.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlug | string |
Name of the asset, more info at https://academy.santiment.net/glossary/#slug. Example: "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" |
Returns number of withdrawal transactions with the option of smaller intervals.
Kind: global function
Returns: number - of results for multiple slugs
number of withdrawal transactions with the option of smaller intervals.
Customfunction:
| Param | Type | Default | Description |
|---|---|---|---|
| projectSlugsList | string |
Comma-separated names of the assets, more info at https://academy.santiment.net/glossary/#slug. Example: "santiment,bitcoin". | |
| 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" |