diff --git a/doc/academy_sheet_functions.md b/doc/academy_sheet_functions.md index 63fad27e..c3608dea 100644 --- a/doc/academy_sheet_functions.md +++ b/doc/academy_sheet_functions.md @@ -1,7 +1,7 @@ --- title: Functions we offer author: Santiment Team -date: 2021-10-29 +date: 2022-02-08 --- ## SAN_ACTIVE_ADDRESSES @@ -472,6 +472,180 @@ Returns the closing price for a given day. | projectSlug | string | Name of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment). | | day | date | The date to fetch the data. Example: DATE(2018, 9, 20) | +## SAN_DAILY_DEPOSIT_TRANSACTIONS + +##### SAN_DAILY_DEPOSIT_TRANSACTIONS(projectSlug, from, to, interval) ⇒ Array + +Returns number of withdrawal transactions. + +- **Kind**: global function +- **Returns**: Array - of number of withdrawal transactions. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + +## SAN_DAILY_DEPOSIT_TRANSACTIONS_AGGREGATED + +##### SAN_DAILY_DEPOSIT_TRANSACTIONS_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number + +Returns number of withdrawal transactions. + +- **Kind**: global function +- **Returns**: number - of aggregated number of withdrawal transactions. +- **Customfunction**: + +| Param | Type | 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 | Aggregation for the timeseries metrics. Example: "LAST" | + +## SAN_DAILY_DEPOSIT_TRANSACTIONS_MULTIPLE_SLUGS + +##### SAN_DAILY_DEPOSIT_TRANSACTIONS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array + +Returns number of withdrawal transactions. + +- **Kind**: global function +- **Returns**: Array - of results for multiple slugs +number of withdrawal transactions. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + +## SAN_DAILY_WITHDRAWAL_TRANSACTIONS + +##### SAN_DAILY_WITHDRAWAL_TRANSACTIONS(projectSlug, from, to, interval) ⇒ Array + +Returns number of withdrawal transactions. + +- **Kind**: global function +- **Returns**: Array - of number of withdrawal transactions. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + +## SAN_DAILY_WITHDRAWAL_TRANSACTIONS_AGGREGATED + +##### SAN_DAILY_WITHDRAWAL_TRANSACTIONS_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number + +Returns number of withdrawal transactions. + +- **Kind**: global function +- **Returns**: number - of aggregated number of withdrawal transactions. +- **Customfunction**: + +| Param | Type | 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 | Aggregation for the timeseries metrics. Example: "LAST" | + +## SAN_DAILY_WITHDRAWAL_TRANSACTIONS_MULTIPLE_SLUGS + +##### SAN_DAILY_WITHDRAWAL_TRANSACTIONS_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array + +Returns number of withdrawal transactions. + +- **Kind**: global function +- **Returns**: Array - of results for multiple slugs +number of withdrawal transactions. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + +## SAN_DEPOSIT_TRANSACTIONS_BY_EXCHANGE + +##### SAN_DEPOSIT_TRANSACTIONS_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array + +Returns the deposit transactions for a slug in a specific exchange + +- **Kind**: global function +- **Returns**: Array - exchange inflow values. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + +## SAN_DEPOSIT_TRANSACTIONS_INTRADAY + +##### SAN_DEPOSIT_TRANSACTIONS_INTRADAY(projectSlug, from, to, interval) ⇒ Array + +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 | 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 | The resolution with which the data is fetched. Example: "5m" | + +## SAN_DEPOSIT_TRANSACTIONS_INTRADAY_AGGREGATED + +##### SAN_DEPOSIT_TRANSACTIONS_INTRADAY_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number + +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 | 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 | Aggregation for the timeseries metrics. Example: "LAST" | + +## SAN_DEPOSIT_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS + +##### SAN_DEPOSIT_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array + +Returns number of withdrawal transactions with the option of smaller intervals. + +- **Kind**: global function +- **Returns**: Array - of results for multiple slugs +number of withdrawal transactions with the option of smaller intervals. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + ## SAN_DEV_ACTIVITY ##### SAN_DEV_ACTIVITY(projectSlug, from, to) ⇒ Array @@ -585,6 +759,24 @@ Returns the exchange balance. | to | date | The ending date to fetch the data. Example: DATE(2018, 9, 21) | | aggregation | string | Aggregation for the timeseries metrics. Example: "LAST" | +## SAN_EXCHANGE_BALANCE_BY_EXCHANGE + +##### SAN_EXCHANGE_BALANCE_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array + +Returns the exchange balance for a slug in a specific exchange + +- **Kind**: global function +- **Returns**: Array - exchange inflow values. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + ## SAN_EXCHANGE_BALANCE_MULTIPLE_SLUGS ##### SAN_EXCHANGE_BALANCE_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array @@ -654,6 +846,24 @@ Returns the exchange inflow. | to | date | The ending date to fetch the data. Example: DATE(2018, 9, 21) | | aggregation | string | Aggregation for the timeseries metrics. Example: "LAST" | +## SAN_EXCHANGE_INFLOW_BY_EXCHANGE + +##### SAN_EXCHANGE_INFLOW_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array + +Returns the exchange inflow for a slug in a specific exchange + +- **Kind**: global function +- **Returns**: Array - exchange inflow values. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + ## SAN_EXCHANGE_INFLOW_MULTIPLE_SLUGS ##### SAN_EXCHANGE_INFLOW_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array @@ -706,6 +916,24 @@ Returns the exchange outflow. | to | date | The ending date to fetch the data. Example: DATE(2018, 9, 21) | | aggregation | string | Aggregation for the timeseries metrics. Example: "LAST" | +## SAN_EXCHANGE_OUTFLOW_BY_EXCHANGE + +##### SAN_EXCHANGE_OUTFLOW_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array + +Returns the exchange outflow for a slug in a specific exchange + +- **Kind**: global function +- **Returns**: Array - exchange inflow values. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + ## SAN_EXCHANGE_OUTFLOW_MULTIPLE_SLUGS ##### SAN_EXCHANGE_OUTFLOW_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array @@ -801,7 +1029,7 @@ Returns the funding rates that are paid by one of the sides of the perpetual con | 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" | +| fundingRateExchange | string | The exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" "FTX" "DYDX" "BITFINEX" "DERIBIT" | | interval | string | The resolution with which the data is fetched. Example: "5m" | ## SAN_FUNDING_RATE_BUSD_AGGREGATED @@ -856,7 +1084,7 @@ Returns the funding rates that are paid by one of the sides of the perpetual con | 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" | +| fundingRateExchange | string | The exchange platform, from which funding rates are fetched, BITMEX by default: "BITMEX" "BINANCE" "FTX" "DYDX" "BITFINEX" "DERIBIT" | | interval | string | The resolution with which the data is fetched. Example: "5m" | ## SAN_FUNDING_RATE_USDT_AGGREGATED @@ -2565,3 +2793,73 @@ the number of transactions transferring more than 100k USD. | from | date | The starting 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 | The resolution with which the data is fetched. Example: "5m" | + +## SAN_WITHDRAWAL_TRANSACTIONS_BY_EXCHANGE + +##### SAN_WITHDRAWAL_TRANSACTIONS_BY_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array + +Returns the withdrawal transactions for a slug in a specific exchange + +- **Kind**: global function +- **Returns**: Array - exchange inflow values. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | + +## SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY + +##### SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY(projectSlug, from, to, interval) ⇒ Array + +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 | 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 | The resolution with which the data is fetched. Example: "5m" | + +## SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_AGGREGATED + +##### SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number + +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 | 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 | Aggregation for the timeseries metrics. Example: "LAST" | + +## SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS + +##### SAN_WITHDRAWAL_TRANSACTIONS_INTRADAY_MULTIPLE_SLUGS(projectSlugsList, from, to, interval) ⇒ Array + +Returns number of withdrawal transactions with the option of smaller intervals. + +- **Kind**: global function +- **Returns**: Array - of results for multiple slugs +number of withdrawal transactions with the option of smaller intervals. +- **Customfunction**: + +| Param | Type | 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 | The resolution with which the data is fetched. Example: "5m" | diff --git a/doc/sheet_functions.md b/doc/sheet_functions.md index 6a1bd7a2..64a1a295 100644 --- a/doc/sheet_functions.md +++ b/doc/sheet_functions.md @@ -100,6 +100,36 @@ it can precede increased volatility in the coin’s price.

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

@@ -124,6 +154,9 @@ ETH spent in the last 7 days, ETH spent in the last day and main contract addres
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.

@@ -137,6 +170,9 @@ the tokens that were withdrawn from an exchange for a given slug and time interv
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.

@@ -146,6 +182,9 @@ the tokens that were withdrawn from an exchange for a given slug and time interv
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.

@@ -499,6 +538,18 @@ transfers that have occurred on a blockchain.

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.

+
@@ -942,6 +993,170 @@ Returns the closing price for a given day. | projectSlug | string | Name of the asset at sanbase, which can be found at the end of the URL (eg. the Santiment URL is https://app.santiment.net/projects/santiment, so the projectSlug would be santiment). | | day | date | The date to fetch the data. Example: DATE(2018, 9, 20) | + + +## SAN\_DAILY\_DEPOSIT\_TRANSACTIONS(projectSlug, from, to, interval) ⇒ Array +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" | + + + +## SAN\_DAILY\_DEPOSIT\_TRANSACTIONS\_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number +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" | + + + +## SAN\_DAILY\_DEPOSIT\_TRANSACTIONS\_MULTIPLE\_SLUGS(projectSlugsList, from, to, interval) ⇒ number +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" | + + + +## SAN\_DAILY\_WITHDRAWAL\_TRANSACTIONS(projectSlug, from, to, interval) ⇒ Array +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" | + + + +## SAN\_DAILY\_WITHDRAWAL\_TRANSACTIONS\_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number +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" | + + + +## SAN\_DAILY\_WITHDRAWAL\_TRANSACTIONS\_MULTIPLE\_SLUGS(projectSlugsList, from, to, interval) ⇒ number +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" | + + + +## SAN\_DEPOSIT\_TRANSACTIONS\_BY\_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array +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" | + + + +## SAN\_DEPOSIT\_TRANSACTIONS\_INTRADAY(projectSlug, from, to, interval) ⇒ Array +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" | + + + +## SAN\_DEPOSIT\_TRANSACTIONS\_INTRADAY\_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number +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" | + + + +## SAN\_DEPOSIT\_TRANSACTIONS\_INTRADAY\_MULTIPLE\_SLUGS(projectSlugsList, from, to, interval) ⇒ number +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" | + ## SAN\_DEV\_ACTIVITY(projectSlug, from, to) ⇒ Array @@ -1047,6 +1262,23 @@ Returns the exchange balance. | to | date | | The ending date to fetch the data. Example: DATE(2018, 9, 21) | | aggregation | string | "null" | Aggregation for the timeseries metrics. Example: "LAST" | + + +## SAN\_EXCHANGE\_BALANCE\_BY\_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array +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" | + ## SAN\_EXCHANGE\_BALANCE\_MULTIPLE\_SLUGS(projectSlugsList, from, to, interval) ⇒ number @@ -1112,6 +1344,23 @@ Returns the exchange inflow. | to | date | | The ending date to fetch the data. Example: DATE(2018, 9, 21) | | aggregation | string | "null" | Aggregation for the timeseries metrics. Example: "LAST" | + + +## SAN\_EXCHANGE\_INFLOW\_BY\_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array +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" | + ## SAN\_EXCHANGE\_INFLOW\_MULTIPLE\_SLUGS(projectSlugsList, from, to, interval) ⇒ number @@ -1161,6 +1410,23 @@ Returns the exchange outflow. | to | date | | The ending date to fetch the data. Example: DATE(2018, 9, 21) | | aggregation | string | "null" | Aggregation for the timeseries metrics. Example: "LAST" | + + +## SAN\_EXCHANGE\_OUTFLOW\_BY\_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array +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" | + ## SAN\_EXCHANGE\_OUTFLOW\_MULTIPLE\_SLUGS(projectSlugsList, from, to, interval) ⇒ number @@ -1249,7 +1515,7 @@ Returns the funding rates that are paid by one of the sides of the perpetual con | 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" | +| 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" | @@ -1301,7 +1567,7 @@ Returns the funding rates that are paid by one of the sides of the perpetual con | 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" | +| 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" | @@ -2915,3 +3181,69 @@ the number of transactions transferring more than 100k USD. | to | date | | The ending date to fetch the data. Example: DATE(2018, 9, 21) | | interval | string | "1d" | The resolution with which the data is fetched. Example: "5m" | + + +## SAN\_WITHDRAWAL\_TRANSACTIONS\_BY\_EXCHANGE(projectSlug, from, to, owner, interval) ⇒ Array +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" | + + + +## SAN\_WITHDRAWAL\_TRANSACTIONS\_INTRADAY(projectSlug, from, to, interval) ⇒ Array +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" | + + + +## SAN\_WITHDRAWAL\_TRANSACTIONS\_INTRADAY\_AGGREGATED(projectSlug, from, to, aggregation) ⇒ number +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" | + + + +## SAN\_WITHDRAWAL\_TRANSACTIONS\_INTRADAY\_MULTIPLE\_SLUGS(projectSlugsList, from, to, interval) ⇒ number +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" | + diff --git a/utils/generateDoc.js b/utils/generateDoc.js index 57784d09..e49824ab 100644 --- a/utils/generateDoc.js +++ b/utils/generateDoc.js @@ -27,7 +27,8 @@ const typeMap = { 'socialVolumeType': 'string', 'numberOfHolders': 'number', 'projectSlugsList': 'string', - 'fundingRateExchange': 'string' + 'fundingRateExchange': 'string', + 'owner': 'string' } const numberFunctions = [