API Reference

Santiment team

2019-09-20

Available Queries

Github Activity

Tier: free

Max lag: A few hours. This metric is depended on an external service - when data is uploaded there, it is available in this query after a few minutes.

Max resolution: 1min

Returns the number of GitHub events generated by a given project repositories. Each project has one or more repositories/organizations that are tracked. A longer description of how the activity is being tracked can be found in this article: Tracking GitHub activity of crypto projects — introducing a better approach

Parameters:

Parameter Description
slug The slug of the project
from From which date to return the activity in ISO 8601 format
to Till which date to return the activity in ISO 8601 format
interval The intervals that should be returned. Default is 1d, which is daily

Example:

{
  githubActivity(slug:"santiment", from:"2019-01-01T00:00:00Z", to:"2019-06-01T00:00:00Z", interval:"1d") {
    datetime
    activity
  }
}

Run in explorer

Dev Activity

Tier: free

Max lag: A few hours. This metric is depended on an external service - when data is uploaded there, it is available in this query after a few minutes.

Max resolution: 1min

Returns the number of GitHub events generated by a given project repositories that are connected with development actions. Each project has one or more repositories/organizations that are tracked. A longer description of how the activity is being tracked can be found in this article: Tracking GitHub activity of crypto projects — introducing a better approach

The difference with the githubActivity API is that the actions counted in this API exclude events that are considered non-development related. These are:

This metric becomes useful if you compare projects that use the github functionality for project management and issue tracking. They are going to have larger githubActivity, compared to projects that use github only for code, as they will generate a lot of events related to issues and tasks.

Parameters:

Parameter Description
slug The slug of the project
from From which date to return the activity in ISO 8601 format
to Till which date to return the activity in ISO 8601 format
interval The intervals that should be returned. Default is 1d, which is daily

Example:

{
  devActivity(
    slug: "santiment"
    from: "2019-01-01T00:00:00Z"
    to: "2019-06-01T00:00:00Z"
    interval: "1d") {
      datetime
      activity
  }
}

Run in explorer

History Price

Tier: free

Max lag: A few minutes

Max resolution: 5min Return the price in USD and BTC, marketcap in USD and volume in USD.

Parameters:

Parameter Description
slug The slug of the project
from From which date to return the activity in ISO 8601 format
to Till which date to return the activity in ISO 8601 format
interval The intervals that should be returned. Default is 1d, which is daily

Example:

{
  historyPrice(
    slug: "santiment"
    from: "2019-01-01T00:00:00Z"
    to: "2019-06-01T00:00:00Z"
    interval: "1d") {
      datetime
      priceUsd
      priceBtc
      marketcap
      volume
  }
}

Run in explorer

OHLC (Open-High-Low-Close)

Tier: free

Max lag: A few minutes

Max resolution: 5min

Returns the open, high, low and close prices in USD for the given interval.

Parameters:

Parameter Description
slug The slug of the project
from From which date to return the activity in ISO 8601 format
to Till which date to return the activity in ISO 8601 format
interval The intervals that should be returned. Default is 1d, which is daily

Example:

{
  ohlc(
    slug: "santiment"
    from: "2019-01-01T00:00:00Z"
    to: "2019-06-01T00:00:00Z"
    interval: "1d") {
      datetime
      openPriceUsd
      highPriceUsd
      lowPriceUsd
      closePriceUsd
  }
}

Run in explorer

History Twitter Data

Tier: free

Max lag: 7 hours

Max resolution: 7 hours

Returns the number of twitter followers of the project’s twitter account over time.

Parameters:

Parameter Description
slug The slug of the project
from From which date to return the activity in ISO 8601 format
to Till which date to return the activity in ISO 8601 format
interval The intervals that should be returned. Default is 1d, which is daily

Example:

{
  historyTwitterData(
    slug: "santiment"
    from: "2019-01-01T00:00:00Z"
    to: "2019-06-01T00:00:00Z"
    interval: "1d") {
      datetime
      followersCount
  }
}

Run in explorer

Social Volume

Tier: free

Max lag: A few hours. This metric is depended on an external service - when data is uploaded there, it is available in this query after a few minutes.

Max resolution: 1min

TODO DESCRIPTION

Parameters:

Parameter Description
slug The slug of the project
from From which date to return the activity in ISO 8601 format
to Till which date to return the activity in ISO 8601 format
interval The intervals that should be returned. Default is 1d, which is daily
socialVolumeType The media source for counting mentions

Example:

{
  socialVolume(
    slug: "santiment"
    from: "2019-01-01T00:00:00Z"
    to: "2019-02-01T00:00:00Z"
    interval: "1h"
    socialVolumeType: DISCORD_DISCUSSION_OVERVIEW) {
      datetime
      mentionsCount
  }
}

Run in explorer

Social Dominance

Tier: free

Max lag: A few hours. This metric is depended on an external service - when data is uploaded there, it is available in this query after a few minutes.

Max resolution: 1min

TODO DESCRIPTION

Parameters:

Parameter Description
slug The slug of the project
from From which date to return the activity in ISO 8601 format
to Till which date to return the activity in ISO 8601 format
interval The intervals that should be returned. Default is 1d, which is daily
source The media source for counting mentions

Example:

{
  socialDominance(
    slug: "santiment"
    from: "2019-01-01T00:00:00Z"
    to: "2019-02-01T00:00:00Z"
    interval: "1h"
    source: ALL) {
      datetime
      dominance
  }
}

Run in explorer