Package for Santiment API access with python

Project description

sanpy

Santiment API python client.

Table of contents

Installation

pip install sanpy

Upgrade to latest version

pip install --upgrade sanpy

Premium metrics

In order to access real time data or historical data (older than 3 months), you'll need to set the api key and have some SAN tokens in your account. All premium metrics are free for "santiment" token.

Configuration

Optionally you can provide an api key which gives access to some premium metrics:

import san
san.ApiConfig.api_key = 'api-key-provided-by-sanbase'

To obtain an api key you should log in to sanbase and go to the account page - https://app.santiment.net/account. There is an API Keys section and a Generate new api key button.

If the account used for generating the api key has enough SAN tokens, the api key will give you access to the data that requires SAN token staking. The api key can only be used to fetch data and not to execute graphql mutations.

Retrieving data from the API

The data is fetched by providing a string in the format query/slug and additional parameters.

query: Available queries can be found in section: Available metrics
slug: A list of projects with their slugs, names, etc. can be fetched like this:

import san
san.get("projects/all")

                name             slug ticker   totalSupply
0             0chain           0chain    ZCN     400000000
1                 0x               0x    ZRX    1000000000
2          0xBitcoin            0xbtc  0xBTC      20999984
...

Parameters:

from_date, to_date - A date or datetime in iso8601 format specifying the start and end datetime for the returned data for ex: 2018-06-01
interval - The interval of the returned data - an integer followed by one of: s, m, h, d or w

Default values for parameters:

from_date: datetime.now() - 365 days
to_date: datetime.now()
interval: '1d'

The returned value for time-series data is in pandas DataFrame format indexed by datetime.

Fetch single metric

import san

san.get(
    "daily_active_addresses/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

san.get(
    "prices/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

Using the defaults params:

san.get("daily_active_addresses/santiment")
san.get("prices/santiment")

Batching multiple queries

from san import Batch

batch = Batch()

batch.get(
    "daily_active_addresses/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

batch.get(
    "daily_active_addresses/santiment",
    from_date="2018-06-06",
    to_date="2018-06-10",
    interval="1d"
)

[daa1, daa2] = batch.execute()

Available metrics

Getting all of the metrics as a list is done, using the following code:

san.available_metrics()

Below are described some available metrics and are given examples for fetching and for the returned format.

All Projects

Returns a DataFrame with all the projects available in the Santiment API. Not all metrics will be available for all the projects. The slug is a unique identifier which can be used to retrieve most of the metrics.

san.get("projects/all")

Example result:

                 name             slug ticker   totalSupply
0              0chain           0chain    ZCN     400000000
1                  0x               0x    ZRX    1000000000
2           0xBitcoin            0xbtc  0xBTC      20999984
3     0xcert Protocol           0xcert    ZXC     500000000
4              1World           1world    1WO      37219453
5        AB-Chain RTB     ab-chain-rtb    RTB      27857813
6             Abulaba          abulaba    AAA     397000000
7                 AC3              ac3    AC3    80235326.0
...

ERC20 Projects

Returns a DataFrame with all the ERC20 projects available in the Santiment API. Not all metrics will be available for all the projects. The slug is a unique identifier which can be used to retrieve most of the metrics.

san.get("projects/erc20")

Example result:

                      name                   slug ticker   totalSupply
0                   0chain                 0chain    ZCN     400000000
1                       0x                     0x    ZRX    1000000000
2                0xBitcoin                  0xbtc  0xBTC      20999984
3          0xcert Protocol                 0xcert    ZXC     500000000
4                   1World                 1world    1WO      37219453
5             AB-Chain RTB           ab-chain-rtb    RTB      27857813
6                  Abulaba                abulaba    AAA     397000000
7                   adbank                 adbank    ADB    1000000000
...

Daily Active Addresses

This metric includes the number of unique addresses that participated in the transfers of given token during the day.

Premium metric

san.get(
    "daily_active_addresses/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

Example result:

                                     value
datetime
2018-06-01 00:00:00+00:00                2
2018-06-02 00:00:00+00:00                4
2018-06-03 00:00:00+00:00                6
2018-06-04 00:00:00+00:00                6
2018-06-05 00:00:00+00:00               14

Network Growth

Network Growth shows the number of new addresses being created on the project network each day.

Premium metric

san.get(
    "network_growth/santiment",
    from_date="2018-12-01",
    to_date="2018-12-05",
    interval="1d"
)

                          newAddresses
datetime
2018-12-01 00:00:00+00:00            3
2018-12-02 00:00:00+00:00            2
2018-12-03 00:00:00+00:00            6
2018-12-04 00:00:00+00:00            2
2018-12-05 00:00:00+00:00            1

Burn Rate - deprecated, replaced by 'Token Age Consumed'

Each transaction has an equivalent burn rate record. The burn rate is calculated by multiplying the number of tokens moved by the number of blocks in which they appeared. Spikes in burn rate could indicate large transactions or movement of tokens that have been held for a long time.

Premium metric

Burn rate returns the same results as 'Token Age Consumed' and will be removed in the near future.

san.get(
    "burn_rate/santiment",
    from_date="2018-05-01",
    to_date="2018-05-05",
    interval="1d"
)

Example result:

                               burnRate
datetime
2018-05-01 00:00:00+00:00      2.514926e+09
2018-05-02 00:00:00+00:00      1.363158e+10
2018-05-03 00:00:00+00:00      2.182971e+09
2018-05-04 00:00:00+00:00      9.731035e+09
2018-05-05 00:00:00+00:00      2.867054e+10

Token Age Consumed

Each transaction has an equivalent 'Age consumed' record. The consumed age is calculated by multiplying the number of tokens moved by the number of blocks in which they appeared. Spikes in consumed token age could indicate large transactions or movement of tokens that have been held for a long time.

Premium metric

san.get(
    "token_age_consumed/santiment",
    from_date="2018-05-01",
    to_date="2018-05-05",
    interval="1d"
)

Example result:

                           tokenAgeConsumed
datetime
2018-05-01 00:00:00+00:00      2.514926e+09
2018-05-02 00:00:00+00:00      1.363158e+10
2018-05-03 00:00:00+00:00      2.182971e+09
2018-05-04 00:00:00+00:00      9.731035e+09
2018-05-05 00:00:00+00:00      2.867054e+10

Average Token Age Consumed in Days

Based on 'Token Age Consumed' above, this returns the Token Age that gets consumed on average over the interval. The result is given in days instead of blocks.

Premium metric

san.get(
    "average_token_age_consumed_in_days/santiment",
    from_date="2018-05-01",
    to_date="2018-05-05",
    interval="1d"
)

Example result:

                             tokenAge
datetime
2018-05-01 00:00:00+00:00    6.353738
2018-05-02 00:00:00+00:00   22.303985
2018-05-03 00:00:00+00:00    3.873644
2018-05-04 00:00:00+00:00  140.566428
2018-05-05 00:00:00+00:00   56.730010

Transaction Volume

Total amount of tokens for a project that were transacted on the blockchain. This metric includes only on-chain volume, not volume in exchanges.

Premium metric

san.get(
    "transaction_volume/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

Example result:

                                       value
datetime
2018-06-01 00:00:00+00:00          46.848943
2018-06-02 00:00:00+00:00         666.194095
2018-06-03 00:00:00+00:00       31326.856743
2018-06-04 00:00:00+00:00        1371.245641
2018-06-05 00:00:00+00:00       42825.036598

Token Velocity

Token Velocity returns the average number of times that a token changes wallets over the interval. Simply put, a higher token velocity means that the same token is used in transactions more often within a set time frame.

Premium metric

san.get(
    "token_velocity/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d")

Example result:

                           tokenVelocity
datetime
2018-06-01 00:00:00+00:00           1.00
2018-06-02 00:00:00+00:00           3.00
2018-06-03 00:00:00+00:00           1.97
2018-06-04 00:00:00+00:00           1.00
2018-06-05 00:00:00+00:00           2.92

Token Circulation

Token Circulation returns the total amount of tokens that have been sent at least once during each given time period. Minimum interval is '1d'.

Premium metric

san.get(
    "token_circulation/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"

Example result:

                           tokenCirculation
datetime
2018-06-01 00:00:00+00:00         46.848943
2018-06-02 00:00:00+00:00        222.194095
2018-06-03 00:00:00+00:00      15933.955221
2018-06-04 00:00:00+00:00       1371.245641
2018-06-05 00:00:00+00:00      14678.249398

Realized Value

Realized Value returns the total acquisition cost of all tokens on the network, based on the historical price when each coin was last sent, in USD. Returns RV for all tokens and RV for all tokens known to be on exchanges.

Premium metric

san.get(
    "realized_value/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

Example result:

                           nonExchangeRealizedValue  realizedValue
datetime
2018-06-01 00:00:00+00:00              2.334917e+07   9.248495e+07
2018-06-02 00:00:00+00:00              2.334917e+07   9.248498e+07
2018-06-03 00:00:00+00:00              2.335106e+07   9.248275e+07
2018-06-04 00:00:00+00:00              2.335138e+07   9.248269e+07
2018-06-05 00:00:00+00:00              2.335073e+07   9.243114e+07

MVRV Ratio

MVRV ratio returns the ratio of the market value of all tokens (market cap) to the realized value of all tokens.

Premium metric

san.get(
    "mvrv_ratio/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

Example result:

                              ratio
datetime
2018-06-01 00:00:00+00:00  0.836489
2018-06-02 00:00:00+00:00  0.850379
2018-06-03 00:00:00+00:00  0.848195
2018-06-04 00:00:00+00:00  0.822243
2018-06-05 00:00:00+00:00  0.781964

NVT Ratio

NVT ratio returns the Network-Value-to-Transactions ratio. We use the market cap as network value and either token circulation or transaction volume as a measurement for transactions, returning two values.

Premium metric

san.get(
    "nvt_ratio/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

Example result:

                           nvtRatioCirculation  nvtRatioTxVolume
datetime
2018-06-01 00:00:00+00:00         1.337498e+06      1.337498e+06
2018-06-02 00:00:00+00:00         2.820074e+05      9.405723e+04
2018-06-03 00:00:00+00:00         3.868500e+03      2.000213e+03
2018-06-04 00:00:00+00:00         4.569595e+04      4.569595e+04
2018-06-05 00:00:00+00:00         4.268927e+03      1.463171e+03

Daily Active Deposits

Daily Active Deposits, similar to Daily Active Addresses, returns the number of unique addresses that participated in the transfers of tokens to exchange deposit addresses during the day.

Premium metric

san.get(
    "daily_active_deposits/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

Example result:

                           activeDeposits
datetime
2018-06-01 00:00:00+00:00               0
2018-06-02 00:00:00+00:00               2
2018-06-03 00:00:00+00:00               0
2018-06-04 00:00:00+00:00               2
2018-06-05 00:00:00+00:00               6

Github Activity

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

Premium metric

An article explaining the github activity tracking

san.get(
    "github_activity/santiment",
    from_date="2018-05-01",
    to_date="2018-05-05",
    interval="1d"
)

Example result:

                           activity
datetime
2018-05-02 00:00:00+00:00        32
2018-05-03 00:00:00+00:00         9
2018-05-04 00:00:00+00:00        18

You can also fetch only events connected to development activity by using the devActivity query.

san.get(
    "dev_activity/santiment",
    from_date="2018-05-01",
    to_date="2018-05-05",
    interval="1d"
)

Example result:

                           activity
datetime
2018-05-02 00:00:00+00:00        29
2018-05-03 00:00:00+00:00         9
2018-05-04 00:00:00+00:00        16

Prices

Fetch history price in USD or BTC, traded volume and marketcap for a given slug.

san.get(
    "prices/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

san.get(
    "prices/ethereum",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

Example result:

                              marketcap  priceBtc  priceUsd   volume
datetime
2018-06-01 00:00:00+00:00  7.736268e+07  0.000165  1.234635   852857
2018-06-02 00:00:00+00:00  7.864724e+07  0.000165  1.255135  1242520
2018-06-03 00:00:00+00:00  7.844339e+07  0.000163  1.251882  1032910
2018-06-04 00:00:00+00:00  7.604326e+07  0.000160  1.213578   617451

                              marketcap  priceBtc    priceUsd      volume
datetime
2018-06-01 00:00:00+00:00  5.756716e+10  0.077083  576.825315  1945890000
2018-06-02 00:00:00+00:00  5.875660e+10  0.077475  588.620775  1880390000
2018-06-03 00:00:00+00:00  6.097134e+10  0.079460  610.682490  1832550000
2018-06-04 00:00:00+00:00  6.015676e+10  0.079466  602.399792  1903430000

Open, High, Close, Low Prices, Volume, Marketcap

Note: this query cannot be batched!

san.get(
    "ohlcv/santiment",
    from_date="2018-06-01",
    to_date="2018-06-05",
    interval="1d"
)

Example result:

                           openPriceUsd  closePriceUsd  highPriceUsd  lowPriceUsd   volume     marketcap
datetime
2018-06-01 00:00:00+00:00       1.24380        1.27668       1.26599      1.19099   852857  7.736268e+07
2018-06-02 00:00:00+00:00       1.26136        1.30779       1.27612      1.20958  1242520  7.864724e+07
2018-06-03 00:00:00+00:00       1.28270        1.28357       1.24625      1.21872  1032910  7.844339e+07
2018-06-04 00:00:00+00:00       1.23276        1.24910       1.18528      1.18010   617451  7.604326e+07

Exchange Funds Flow

Fetch the difference between the tokens that were deposited minus the tokens that were withdrawn from an exchange for a given slug in the selected time period.

Premium metric

san.get(
    "exchange_funds_flow/santiment",
    from_date="2018-04-16T10:02:19Z",
    to_date="2018-05-23T10:02:19Z",
    interval="1d"
)

Example result:

                         inOutDifference
datetime
2018-04-16 10:02:19+00:00    -208.797310
2018-04-17 00:00:00+00:00     164.006467
2018-04-18 00:00:00+00:00       0.000000
2018-04-19 00:00:00+00:00  -45213.112849
2018-04-20 00:00:00+00:00 -135364.839572

Social Volume Projects

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

san.get("social_volume_projects")

Example result:

                   0
0            cardano
1       bitcoin-cash
2            bitcoin
3        dragonchain
4                eos
5   ethereum-classic
6           ethereum
7      kyber-network
8           litecoin
9               iota
10          ontology
11              tron
12          wanchain
13           stellar
14            ripple
15             verge
16                0x

Social Volume

Fetch a list of mentions count for a given project and time interval.

Premium metric

Arguments description:

endpoint - social_volume/project_slug
interval - an integer followed by one of: m, h, d, w
from_date - a string representation of datetime value according to the iso8601 standard, e.g. "2018-04-16T10:02:19Z"
to_date - a string representation of datetime value according to the iso8601 standard, e.g. "2018-05-23T10:02:19Z"
social_volume_type - the source of mention counts, one of the following:
- "PROFESSIONAL_TRADERS_CHAT_OVERVIEW" - shows how many times the given project was mentioned in the professional traders chat
- "TELEGRAM_CHATS_OVERVIEW" - shows how many times the given project was mentioned across all telegram chats, except the project's own community chat (if there is one)
- "TELEGRAM_DISCUSSION_OVERVIEW" - the general volume of messages in the project's community chat (if there is one)
- "DISCORD_DISCUSSION_OVERVIEW" - shows how many times the given project has been mentioned in the discord channels

san.get(
    "social_volume/dragonchain",
    interval="1d",
    from_date="2018-04-16T10:02:19Z",
    to_date="2018-05-23T10:02:19Z",
    social_volume_type="PROFESSIONAL_TRADERS_CHAT_OVERVIEW"
)

Example result:

                           mentionsCount
datetime
2018-04-17 00:00:00+00:00              4
2018-04-18 00:00:00+00:00              8
2018-04-19 00:00:00+00:00              7
2018-04-20 00:00:00+00:00              1
2018-04-21 00:00:00+00:00              3
2018-04-22 00:00:00+00:00              2
2018-04-23 00:00:00+00:00              1

Topic search

Returns lists with the mentions of the search phrase from the selected source. The results are in two formats - the messages themselves and the data for building graph representation of the result.

Premium metric

Arguments description:

endpoint - a string in the format "topic_search"
source - one of the following:
- TELEGRAM
- PROFESSIONAL_TRADERS_CHAT
- REDDIT
- DISCORD
search_text - a string containing the key words for which the sources should be searched.
from_date - a string representation of datetime value according to the iso8601 standard, e.g. "2018-04-16T10:02:19Z"
to_date - a string representation of datetime value according to the iso8601 standard, e.g. "2018-04-16T10:02:19Z"
interval - an integer followed by one of: m, h, d, w

san.get(
    "topic_search",
    source="TELEGRAM",
    search_text="btc moon",
    from_date="2019-08-01T12:00:00Z",
    to_date="2019-08-02T12:00:00Z",
    interval="6h"
)

Example result:

datetime                   mentionsCount
2019-08-01 12:00:00+00:00            208
2019-08-01 18:00:00+00:00            265
2019-08-02 00:00:00+00:00            115
2019-08-02 06:00:00+00:00            219
2019-08-02 12:00:00+00:00            358
2019-08-02 18:00:00+00:00            212
2019-08-03 00:00:00+00:00            229
2019-08-03 06:00:00+00:00            225

Share of Deposits

Returns information for the shares of deposits that a given project has during the time interval.

Premium metric

san.get(
    "share_of_deposits/santiment",
    from_date="2019-01-01T00:00:00Z",
    to_date="2019-01-05T00:00:00Z",
    interval="1d"
)

Example result:

                           activeAddresses  activeDeposits  shareOfDeposits
datetime
2019-01-01 00:00:00+00:00                5               1        20.000000
2019-01-02 00:00:00+00:00                2               0         0.000000
2019-01-03 00:00:00+00:00               13               2        15.384615
2019-01-04 00:00:00+00:00                8               2        25.000000
2019-01-05 00:00:00+00:00                7               1        14.285714

Gas Used

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. Currently only ETH is supported.

Premium metric

san.get(
    "gas_used/ethereum",
    from_date="2019-06-01",
    to_date="2019-06-05",
    interval="1d"
)

Example result:

datetime                       gasUsed
2019-06-01 00:00:00+00:00  47405557702
2019-06-02 00:00:00+00:00  44769162038
2019-06-03 00:00:00+00:00  46415901420
2019-06-04 00:00:00+00:00  46907686393
2019-06-05 00:00:00+00:00  45925073341

Miners Balance

Returns miner balances over time. Currently only ETH is supported.

Premium metric

san.get(
    "miners_balance/ethereum",
    from_date="2019-06-01",
    to_date="2019-06-05",
    interval="1d"
)

Example result:

datetime                        balance
2019-06-01 00:00:00+00:00  1.529488e+06
2019-06-02 00:00:00+00:00  1.533494e+06
2019-06-03 00:00:00+00:00  1.527438e+06
2019-06-04 00:00:00+00:00  1.525666e+06
2019-06-05 00:00:00+00:00  1.527563e+06

Mining Pools Distribution

Returns 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.

Premium metric

san.get(
    "mining_pools_distribution/ethereum",
    from_date="2019-06-01",
    to_date="2019-06-05",
    interval="1d"
)

Example result:

datetime                      other     top10      top3
2019-06-01 00:00:00+00:00  0.129237  0.249906  0.620857
2019-06-02 00:00:00+00:00  0.127432  0.251903  0.620666
2019-06-03 00:00:00+00:00  0.122058  0.249603  0.628339
2019-06-04 00:00:00+00:00  0.127726  0.254982  0.617293
2019-06-05 00:00:00+00:00  0.120436  0.265842  0.613722

Historical Balance

Historical balance for erc20 token or eth address. Returns the historical balance for a given address in the given interval.

san.get(
    "historical_balance/santiment",
    address="0x1f3df0b8390bb8e9e322972c5e75583e87608ec2",
    from_date="2019-04-18",
    to_date="2019-04-23",
    interval="1d"
)

Example result:

datetime                     balance
2019-04-18 00:00:00+00:00  382338.33
2019-04-19 00:00:00+00:00  382338.33
2019-04-20 00:00:00+00:00  382338.33
2019-04-21 00:00:00+00:00  215664.33
2019-04-22 00:00:00+00:00  215664.33

Social Dominance

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

Available sources are:

PROFESSIONAL_TRADERS_CHAT
TELEGRAM
DISCORD
REDDIT
ALL

Premium metric

san.get(
    "social_dominance/santiment",
    from_date="2019-04-08",
    to_date="2019-04-13",
    interval="1d",
    source="ALL"
)

Example result:

datetime                   dominance
2019-04-08 00:00:00+00:00   0.043028
2019-04-09 00:00:00+00:00   0.025337
2019-04-10 00:00:00+00:00   0.045376
2019-04-11 00:00:00+00:00   0.036051
2019-04-12 00:00:00+00:00   0.035585
2019-04-13 00:00:00+00:00   0.034957

Top Holders Percent Of Total Supply

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

san.get(
    "top_holders_percent_of_total_supply/ethereum",
    number_of_holders=10,
    from_date="2019-04-08",
    to_date="2019-04-11"
)

Example Result:

datetime                   inExchanges  inTopHoldersTotal  outsideExchanges
2019-04-09 00:00:00+00:00     7.977318          13.277961          5.300643
2019-04-10 00:00:00+00:00     7.976282          13.310953          5.334671
2019-04-11 00:00:00+00:00     7.975260          13.296356          5.321096

History Twitter Data

Fetch the historical count of twitter followers.

san.get(
    "history_twitter_data/santiment",
    from_date="2019-04-08",
    to_date="2019-04-13",
    interval="1d"
)

Example result:

datetime                   followers_count
2019-04-08 00:00:00+00:00            10524
2019-04-09 00:00:00+00:00            10524
2019-04-10 00:00:00+00:00            10525
2019-04-11 00:00:00+00:00            10520
2019-04-12 00:00:00+00:00            10526
2019-04-13 00:00:00+00:00            10529

Price Volume Difference

Fetch the price-volume difference technical indicator for a given slug, display currency and time period. This indicator measures the difference in trend between price and volume, specifically when price goes up as volume goes down.

san.get(
    "price_volume_difference/santiment",
    from_date="2019-04-18",
    to_date="2019-04-23",
    interval="1d",
    currency="USD"
)

Example result:

datetime                   priceChange  priceVolumeDiff  volumeChange
2019-04-18 00:00:00+00:00     0.017779         0.013606 -39908.007476
2019-04-19 00:00:00+00:00     0.012587         0.007332 -31195.568878
2019-04-20 00:00:00+00:00     0.009062         0.004169 -24550.100411
2019-04-21 00:00:00+00:00     0.002573         0.001035 -19307.845911
2019-04-22 00:00:00+00:00     0.001527         0.000703 -20317.934666

Ethereum Top Transactions

Top ETH transactions for project's team wallets.

Available transaction types:

san.get(
    "eth_top_transactions/santiment",
    from_date="2019-04-18",
    to_date="2019-04-30",
    limit=5,
    transaction_type="ALL"
)

Example result:

The result is shortened for convenience

datetime                           fromAddress  fromAddressInExchange           toAddress  toAddressInExchange              trxHash      trxValue
2019-04-29 21:33:31+00:00  0xe76fe52a251c8f...                  False  0x45d6275d9496b...                False  0x776cd57382456a...        100.00
2019-04-29 21:21:18+00:00  0xe76fe52a251c8f...                  False  0x468bdccdc334f...                False  0x848414fb5c382f...         40.95
2019-04-19 14:14:52+00:00  0x1f3df0b8390bb8...                  False  0xd69bc0585e05e...                False  0x590512e1f1fbcf...         19.48
2019-04-19 14:09:58+00:00  0x1f3df0b8390bb8...                  False  0x723fb5c14eaff...                False  0x78e0720b9e72d1...         15.15

News

Returns the news for given word.

Arguments description:

tag - project name, ticker or other crypto related words.
from - a string representation of datetime value according to the iso8601 standard, e.g. "2018-04-16"
to - a string representation of datetime value according to the iso8601 standard, e.g. "2018-04-16"
size - size limit of the returned results

Premium metric

san.get(
    "news/bitcoin",
    from_date="2019-04-18",
    to_date="2019-07-11",
    size=5
)

Example result:

The result is shortened for convenience

datetime                                                               title                                        description       sourceName                                                                                                       url
2019-04-26 18:39:00+00:00  Crypto Markets Slump, Oil Prices Report Losses...  Crypto Markets Slump, Oil Prices Report Losses...    Cointelegraph                              https://cointelegraph.com/news/crypto-markets-slump-oil-prices-report-losses
2019-05-17 09:02:07+00:00  Debt-Ridden Crypto Exchange Cryptopia Suckers ...  Debt-Ridden Crypto Exchange Cryptopia Suckers ...              CCN                  https://www.ccn.com/debt-ridden-crypto-exchange-cryptopia-suckers-hacked-customers-again
2019-05-27 18:56:15+00:00  Institutions Could Push Crypto Past A ‘Point O...  Institutions Could Push Crypto Past A ‘Point O...  Crypto Briefing                                          https://cryptobriefing.com/institutional-crypto-point-no-return/
2019-06-22 14:31:00+00:00  ETH Hits 10-Month High as Crypto Markets See S...  ETH Hits 10-Month High as Crypto Markets See S...    Cointelegraph                   https://cointelegraph.com/news/eth-hits-10-month-high-as-crypto-markets-see-solid-green
2019-07-06 18:42:00+00:00  Iranian Official Says US Congress is Working t...  Iranian Official Says US Congress is Working t...    Cointelegraph  https://cointelegraph.com/news/iranian-official-says-us-congress-is-working-to-block-irans-crypto-mining

Ethereum Spent Over Time

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

san.get(
    "eth_spent_over_time/santiment",
    from_date="2019-04-18",
    to_date="2019-04-23",
    interval="1d"
)

Example result:

datetime                    ethSpent
2019-04-18 00:00:00+00:00   0.000000
2019-04-19 00:00:00+00:00  34.630284
2019-04-20 00:00:00+00:00   0.000000
2019-04-21 00:00:00+00:00   0.000158
2019-04-22 00:00:00+00:00   0.000000

Token Top Transactions

Top transactions for the token of a given project

san.get(
    "token_top_transactions/santiment",
    from_date="2019-04-18",
    to_date="2019-04-30",
    limit=5
)

Example result:

The result is shortened for convenience

datetime                           fromAddress  fromAddressInExchange           toAddress  toAddressInExchange              trxHash      trxValue
2019-04-21 13:51:59+00:00  0x1f3df0b8390bb8...                  False  0x5eaae5e949952...                False  0xdbced935b09dd0...  166674.00000
2019-04-28 07:43:38+00:00  0x0a920bfdf7f977...                  False  0x868074aab18ea...                False  0x5f2214d34bcdc3...   33181.82279
2019-04-28 07:53:32+00:00  0x868074aab18ea3...                  False  0x876eabf441b2e...                 True  0x90bd286da38a2b...   33181.82279
2019-04-26 14:38:45+00:00  0x876eabf441b2ee...                   True  0x76af586d041d6...                False  0xe45b86f415e930...   28999.64023
2019-04-30 15:17:28+00:00  0x876eabf441b2ee...                   True  0x1f4a90043cf2d...                False  0xc85892b9ef8c64...   20544.42975

Full list of on-chain metrics

This list includes:

MVRV
Age Destroyed
Transaction Volume
Circulation
NVT
Realized Value
Realized Price
Velocity
Mean Age
Exchange Metrics

All of the following metrics have accept the same parameters and have the same response structure

Returns data for a given metric. The input, that is needed, is the string 'metric/slug', a 'from' date, a 'to' date, a string for the interval and an aggregation, which is optional (When not given, the aggregation is determined automatically by the API).

The available metrics can be seen here:

san.get(
   "daily_active_addresses/santiment",
   from_date="2019-08-31",
   to_date="2019-09-03",
   interval="2d",
   aggregation="AVG"
)

Example result:

datetime                      value
2019-08-30 00:00:00+00:00    4.0
2019-09-01 00:00:00+00:00    5.5
2019-09-03 00:00:00+00:00    9.0

Emerging Trends

Emerging trends for a given period of time

san.get(
    "emerging_trends",
    from_date="2019-07-01",
    to_date="2019-07-02",
    interval="1d",
    size=5
)

Example result:

datetime                        score    word
2019-07-01 00:00:00+00:00  375.160034    lnbc
2019-07-01 00:00:00+00:00  355.323281    dent
2019-07-01 00:00:00+00:00  268.653820    link
2019-07-01 00:00:00+00:00  231.721809  shorts
2019-07-01 00:00:00+00:00  206.812798     btt
2019-07-02 00:00:00+00:00  209.343752  bounce
2019-07-02 00:00:00+00:00  135.412811    vidt
2019-07-02 00:00:00+00:00  116.842801     bat
2019-07-02 00:00:00+00:00   98.517600  bottom
2019-07-02 00:00:00+00:00   89.309975   haiku

Top Social Gainers Losers

Top social gainers/losers returns the social volume changes for crypto projects.

san.get(
    "top_social_gainers_losers",
    from_date="2019-07-18",
    to_date="2019-07-30",
    size=5,
    time_window="2d",
    status="ALL"
)

Example result:

The result is shortened for convenience

datetime                              slug     change    status
2019-07-28 01:00:00+00:00     libra-credit  21.000000    GAINER
2019-07-28 01:00:00+00:00             aeon  -1.000000     LOSER
2019-07-28 01:00:00+00:00    thunder-token   5.000000  NEWCOMER
2019-07-28 02:00:00+00:00     libra-credit  43.000000    GAINER
...                                    ...        ...       ...    
2019-07-30 07:00:00+00:00            storj  12.000000  NEWCOMER
2019-07-30 11:00:00+00:00            storj  21.000000    GAINER
2019-07-30 11:00:00+00:00            aergo  -1.000000     LOSER
2019-07-30 11:00:00+00:00            litex   8.000000  NEWCOMER

Running tests

python setup.py test

Running integration tests

python setup.py nosetests -a integration

Project details

Release history Release notifications | RSS feed

0.12.0

Mar 21, 2024

0.11.8

Dec 15, 2023

0.11.6

Mar 29, 2023

0.11.5

Feb 1, 2023

0.11.4

Jan 28, 2023

0.11.3

Nov 4, 2022

0.11.2

Oct 27, 2022

0.11.1

Oct 27, 2022

0.11.0

Oct 27, 2022

0.10.2

Sep 29, 2022

0.10.1

Aug 30, 2022

0.10.0

Jun 15, 2022

0.9.1

Jan 13, 2022

0.8.12

Nov 26, 2021

0.8.11

Aug 24, 2021

0.8.10

Aug 24, 2021

0.8.9

Jul 15, 2021

0.8.8

Jul 7, 2021

0.8.7

May 7, 2021

0.8.6

Nov 23, 2020

0.8.5

Aug 24, 2020

0.8.4

Jul 24, 2020

0.8.3

Jul 9, 2020

0.8.2

Jul 2, 2020

0.8.0

Jun 25, 2020

0.7.19

Jun 18, 2020

0.7.18

Mar 25, 2020

0.7.16

Feb 20, 2020

0.7.15

Feb 4, 2020

0.7.14

Jan 27, 2020

0.7.13

Jan 21, 2020

This version

0.7.11

Jan 7, 2020

0.7.10

Dec 19, 2019

0.7.9

Dec 10, 2019

0.7.8

Nov 29, 2019

0.7.5

Nov 4, 2019

0.7.4

Nov 1, 2019

0.7.1

Oct 7, 2019

0.7.0

Sep 18, 2019

0.6.1

Jul 22, 2019

0.6.0

Jul 22, 2019

0.5.3

Jul 9, 2019

0.5.2

Jun 28, 2019

0.5.1

Jun 20, 2019

0.5.0

May 7, 2019

0.4.2

May 2, 2019

0.4.1

Apr 8, 2019

0.3.4

Feb 11, 2019

0.3.3

Feb 7, 2019

0.3.2

Jan 25, 2019

0.3.1

Jan 14, 2019

0.3.0

Dec 20, 2018

0.2.1

Dec 11, 2018

0.2.0

Dec 4, 2018

0.1.6

Nov 13, 2018

0.1.5

Oct 26, 2018

0.1.4

Oct 25, 2018

0.1.2

Oct 19, 2018

0.1.1

Oct 18, 2018

0.1.0

Oct 11, 2018

0.0.20

Oct 10, 2018

0.0.19

Oct 9, 2018

0.0.18

Sep 21, 2018

0.0.17

Sep 20, 2018

0.0.16

Sep 19, 2018

0.0.13

Sep 11, 2018

0.0.12

Aug 15, 2018

0.0.9

Aug 15, 2018

0.0.6

Jul 6, 2018

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sanpy-0.7.11.tar.gz (41.7 kB view hashes)

Uploaded Jan 7, 2020 Source

Built Distribution

sanpy-0.7.11-py3-none-any.whl (29.6 kB view hashes)

Uploaded Jan 7, 2020 Python 3

Hashes for sanpy-0.7.11.tar.gz

Hashes for sanpy-0.7.11.tar.gz
Algorithm	Hash digest
SHA256	`803ca4875f76e2308ed61786c5136b72562c17bc1de27ceab6006a04a030835f`
MD5	`3ead1256aed371b3a39536b9b147d58c`
BLAKE2b-256	`c8674c0c4e94ba253df12e99c5699860d1e3990c1a2d1fe191f6776b4dfbaf10`

Hashes for sanpy-0.7.11-py3-none-any.whl

Hashes for sanpy-0.7.11-py3-none-any.whl
Algorithm	Hash digest
SHA256	`932dfa5586412ee5e7b4615062e8f5ac1179a87199950e12f1e21a096b03de84`
MD5	`671e11490e47e1a96616712d9f1d8c83`
BLAKE2b-256	`95103f1db87da7ca70ad38e63d8f184785f98ff0561b07c4464f1e2c17544cfa`

sanpy 0.7.11

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Project description

sanpy

Table of contents

Installation

Upgrade to latest version

Premium metrics

Configuration

Retrieving data from the API

Fetch single metric

Batching multiple queries

Available metrics

All Projects

ERC20 Projects

Daily Active Addresses

Network Growth

Burn Rate - deprecated, replaced by 'Token Age Consumed'

Token Age Consumed

Average Token Age Consumed in Days

Transaction Volume

Token Velocity

Token Circulation

Realized Value

MVRV Ratio

NVT Ratio

Daily Active Deposits

Github Activity

Prices

Open, High, Close, Low Prices, Volume, Marketcap

Exchange Funds Flow

Social Volume Projects

Social Volume

Topic search

Share of Deposits

Gas Used

Miners Balance

Mining Pools Distribution

Historical Balance

Social Dominance

Top Holders Percent Of Total Supply

History Twitter Data

Price Volume Difference

Ethereum Top Transactions

News

Ethereum Spent Over Time

Token Top Transactions

Full list of on-chain metrics

Emerging Trends

Top Social Gainers Losers

Running tests

Running integration tests

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution