Parameters¶
Some endpoints require input parameters belonging to specific domains.
On this page, all domains can be found in order to be in line with the standards required by the API.
Bases: CyholeParam
flowchart TD
cyhole.gecko.param.GeckoTimeframe[GeckoTimeframe]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.gecko.param.GeckoTimeframe
click cyhole.gecko.param.GeckoTimeframe href "" "cyhole.gecko.param.GeckoTimeframe"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Timeframe granularity used by the OHLCV endpoints (pool and token).
aggregate query parameter values depend on the chosen timeframe:
DAY:"1".HOUR:"1","4","12".MINUTE:"1","5","15".SECOND:"1","15","30".
Bases: CyholeParam
flowchart TD
cyhole.gecko.param.GeckoCurrency[GeckoCurrency]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.gecko.param.GeckoCurrency
click cyhole.gecko.param.GeckoCurrency href "" "cyhole.gecko.param.GeckoCurrency"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Currency unit for OHLCV candle values (usd or quoted in token).
Bases: CyholeParam
flowchart TD
cyhole.gecko.param.GeckoTokenSide[GeckoTokenSide]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.gecko.param.GeckoTokenSide
click cyhole.gecko.param.GeckoTokenSide href "" "cyhole.gecko.param.GeckoTokenSide"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Token side used by OHLCV/trades endpoints to indicate which side of the pool a price refers to.
Bases: CyholeParam
flowchart TD
cyhole.gecko.param.GeckoHoldersChartDays[GeckoHoldersChartDays]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.gecko.param.GeckoHoldersChartDays
click cyhole.gecko.param.GeckoHoldersChartDays href "" "cyhole.gecko.param.GeckoHoldersChartDays"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Window covered by the token-holders chart endpoint.
Bases: CyholeParam
flowchart TD
cyhole.gecko.param.GeckoTopTradersSort[GeckoTopTradersSort]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.gecko.param.GeckoTopTradersSort
click cyhole.gecko.param.GeckoTopTradersSort href "" "cyhole.gecko.param.GeckoTopTradersSort"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Sorting criterion accepted by the top-traders endpoint.
Bases: CyholeParam
flowchart TD
cyhole.gecko.param.GeckoTokenDataInclude[GeckoTokenDataInclude]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.gecko.param.GeckoTokenDataInclude
click cyhole.gecko.param.GeckoTokenDataInclude href "" "cyhole.gecko.param.GeckoTokenDataInclude"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
include query value used by the token-data endpoints to embed related pools in the response.
Bases: CyholeParam
flowchart TD
cyhole.gecko.param.GeckoRecentlyUpdatedInclude[GeckoRecentlyUpdatedInclude]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.gecko.param.GeckoRecentlyUpdatedInclude
click cyhole.gecko.param.GeckoRecentlyUpdatedInclude href "" "cyhole.gecko.param.GeckoRecentlyUpdatedInclude"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
include query value for the recently-updated-tokens endpoint to embed the network resource.
Bases: CyholeParam
flowchart TD
cyhole.gecko.param.GeckoSearchInclude[GeckoSearchInclude]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.gecko.param.GeckoSearchInclude
click cyhole.gecko.param.GeckoSearchInclude href "" "cyhole.gecko.param.GeckoSearchInclude"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
include query values accepted by the search-pools endpoint; pass any combination as comma-separated.