From 4d839baf879d67207d31a3ab193a34dee1325b14 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 1 May 2026 04:45:35 +0000 Subject: [PATCH 1/8] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 1fd38d8..d24f82c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 85 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/coingecko/coingecko-fb6b6a203ce654df6f662bce7e112dbbab1106024132e5b8145fefc7b3297436.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/coingecko/coingecko-498a8fcd82c22d90d394dcff640d8fe35fb8f7a0deea71454364edf90d3b1baa.yml openapi_spec_hash: 56fbbaf3608f6cde0b9ed8854fdaeb4c config_hash: c77352c905b1a7d1ab31960e5195bddf From f32c0f3d2e71c274c00f2b5e9608be42c5e5169b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 1 May 2026 04:49:16 +0000 Subject: [PATCH 2/8] chore(internal): reformat pyproject.toml --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index c63d2c8..de2da83 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -168,7 +168,7 @@ show_error_codes = true # # We also exclude our `tests` as mypy doesn't always infer # types correctly and Pyright will still catch any type errors. -exclude = ['src/coingecko_sdk/_files.py', '_dev/.*.py', 'tests/.*'] +exclude = ["src/coingecko_sdk/_files.py", "_dev/.*.py", "tests/.*"] strict_equality = true implicit_reexport = true From 3852f84ead0b60a88a936e52309aee30a0743030 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 9 May 2026 03:58:09 +0000 Subject: [PATCH 3/8] fix(client): add missing f-string prefix in file type error message --- src/coingecko_sdk/_files.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/coingecko_sdk/_files.py b/src/coingecko_sdk/_files.py index 0fdce17..76da9e0 100644 --- a/src/coingecko_sdk/_files.py +++ b/src/coingecko_sdk/_files.py @@ -99,7 +99,7 @@ async def async_to_httpx_files(files: RequestFiles | None) -> HttpxRequestFiles elif is_sequence_t(files): files = [(key, await _async_transform_file(file)) for key, file in files] else: - raise TypeError("Unexpected file type input {type(files)}, expected mapping or sequence") + raise TypeError(f"Unexpected file type input {type(files)}, expected mapping or sequence") return files From c6c8ef9a176183c52f134c1a81bb0f8eec3fb832 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 12 May 2026 03:49:34 +0000 Subject: [PATCH 4/8] feat(internal/types): support eagerly validating pydantic iterators --- src/coingecko_sdk/_models.py | 80 ++++++++++++++++++++++++++++++++++++ tests/test_models.py | 60 +++++++++++++++++++++++++-- 2 files changed, 137 insertions(+), 3 deletions(-) diff --git a/src/coingecko_sdk/_models.py b/src/coingecko_sdk/_models.py index 29070e0..8c5ab26 100644 --- a/src/coingecko_sdk/_models.py +++ b/src/coingecko_sdk/_models.py @@ -25,7 +25,9 @@ ClassVar, Protocol, Required, + Annotated, ParamSpec, + TypeAlias, TypedDict, TypeGuard, final, @@ -79,7 +81,15 @@ from ._constants import RAW_RESPONSE_HEADER if TYPE_CHECKING: + from pydantic import GetCoreSchemaHandler, ValidatorFunctionWrapHandler + from pydantic_core import CoreSchema, core_schema from pydantic_core.core_schema import ModelField, ModelSchema, LiteralSchema, ModelFieldsSchema +else: + try: + from pydantic_core import CoreSchema, core_schema + except ImportError: + CoreSchema = None + core_schema = None __all__ = ["BaseModel", "GenericModel"] @@ -396,6 +406,76 @@ def model_dump_json( ) +class _EagerIterable(list[_T], Generic[_T]): + """ + Accepts any Iterable[T] input (including generators), consumes it + eagerly, and validates all items upfront. + + Validation preserves the original container type where possible + (e.g. a set[T] stays a set[T]). Serialization (model_dump / JSON) + always emits a list — round-tripping through model_dump() will not + restore the original container type. + """ + + @classmethod + def __get_pydantic_core_schema__( + cls, + source_type: Any, + handler: GetCoreSchemaHandler, + ) -> CoreSchema: + (item_type,) = get_args(source_type) or (Any,) + item_schema: CoreSchema = handler.generate_schema(item_type) + list_of_items_schema: CoreSchema = core_schema.list_schema(item_schema) + + return core_schema.no_info_wrap_validator_function( + cls._validate, + list_of_items_schema, + serialization=core_schema.plain_serializer_function_ser_schema( + cls._serialize, + info_arg=False, + ), + ) + + @staticmethod + def _validate(v: Iterable[_T], handler: "ValidatorFunctionWrapHandler") -> Any: + original_type: type[Any] = type(v) + + # Normalize to list so list_schema can validate each item + if isinstance(v, list): + items: list[_T] = v + else: + try: + items = list(v) + except TypeError as e: + raise TypeError("Value is not iterable") from e + + # Validate items against the inner schema + validated: list[_T] = handler(items) + + # Reconstruct original container type + if original_type is list: + return validated + # str(list) produces the list's repr, not a string built from items, + # so skip reconstruction for str and its subclasses. + if issubclass(original_type, str): + return validated + try: + return original_type(validated) + except (TypeError, ValueError): + # If the type cannot be reconstructed, just return the validated list + return validated + + @staticmethod + def _serialize(v: Iterable[_T]) -> list[_T]: + """Always serialize as a list so Pydantic's JSON encoder is happy.""" + if isinstance(v, list): + return v + return list(v) + + +EagerIterable: TypeAlias = Annotated[Iterable[_T], _EagerIterable] + + def _construct_field(value: object, field: FieldInfo, key: str) -> object: if value is None: return field_get_default(field) diff --git a/tests/test_models.py b/tests/test_models.py index ab46547..f017361 100644 --- a/tests/test_models.py +++ b/tests/test_models.py @@ -1,7 +1,8 @@ import json -from typing import TYPE_CHECKING, Any, Dict, List, Union, Optional, cast +from typing import TYPE_CHECKING, Any, Dict, List, Union, Iterable, Optional, cast from datetime import datetime, timezone -from typing_extensions import Literal, Annotated, TypeAliasType +from collections import deque +from typing_extensions import Literal, Annotated, TypedDict, TypeAliasType import pytest import pydantic @@ -9,7 +10,7 @@ from coingecko_sdk._utils import PropertyInfo from coingecko_sdk._compat import PYDANTIC_V1, parse_obj, model_dump, model_json -from coingecko_sdk._models import DISCRIMINATOR_CACHE, BaseModel, construct_type +from coingecko_sdk._models import DISCRIMINATOR_CACHE, BaseModel, EagerIterable, construct_type class BasicModel(BaseModel): @@ -961,3 +962,56 @@ def __getattr__(self, attr: str) -> Item: ... assert model.a.prop == 1 assert isinstance(model.a, Item) assert model.other == "foo" + + +# NOTE: Workaround for Pydantic Iterable behavior. +# Iterable fields are replaced with a ValidatorIterator and may be consumed +# during serialization, which can cause subsequent dumps to return empty data. +# See: https://github.com/pydantic/pydantic/issues/9541 +@pytest.mark.parametrize( + "data, expected_validated", + [ + ([1, 2, 3], [1, 2, 3]), + ((1, 2, 3), (1, 2, 3)), + (set([1, 2, 3]), set([1, 2, 3])), + (iter([1, 2, 3]), [1, 2, 3]), + ([], []), + ((x for x in [1, 2, 3]), [1, 2, 3]), + (map(lambda x: x, [1, 2, 3]), [1, 2, 3]), + (frozenset([1, 2, 3]), frozenset([1, 2, 3])), + (deque([1, 2, 3]), deque([1, 2, 3])), + ], + ids=["list", "tuple", "set", "iterator", "empty", "generator", "map", "frozenset", "deque"], +) +@pytest.mark.skipif(PYDANTIC_V1, reason="this is only supported in pydantic v2") +def test_iterable_construction(data: Iterable[int], expected_validated: Iterable[int]) -> None: + class TypeWithIterable(TypedDict): + items: EagerIterable[int] + + class Model(BaseModel): + data: TypeWithIterable + + m = Model.model_validate({"data": {"items": data}}) + assert m.data["items"] == expected_validated + + # Verify repeated dumps don't lose data (the original bug) + assert m.model_dump()["data"]["items"] == list(expected_validated) + assert m.model_dump()["data"]["items"] == list(expected_validated) + + +@pytest.mark.skipif(PYDANTIC_V1, reason="this is only supported in pydantic v2") +def test_iterable_construction_str_falls_back_to_list() -> None: + # str is iterable (over chars), but str(list_of_chars) produces the list's repr + # rather than reconstructing a string from items. We special-case str to fall + # back to list instead of attempting reconstruction. + class TypeWithIterable(TypedDict): + items: EagerIterable[str] + + class Model(BaseModel): + data: TypeWithIterable + + m = Model.model_validate({"data": {"items": "hello"}}) + + # falls back to list of chars rather than calling str(["h", "e", "l", "l", "o"]) + assert m.data["items"] == ["h", "e", "l", "l", "o"] + assert m.model_dump()["data"]["items"] == ["h", "e", "l", "l", "o"] From cdf9f39b4ec846475f1172b126fafa232fe113d2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 13 May 2026 03:02:34 +0000 Subject: [PATCH 5/8] ci: pin GitHub Actions to commit SHAs Pin all GitHub Actions referenced in generated workflows (both first-party `actions/*` and third-party) to immutable commit SHAs. Updating pinned actions is now a deliberate codegen-side bump rather than implicit on every workflow run. --- .github/workflows/ci.yml | 8 ++++---- .github/workflows/publish-pypi.yml | 2 +- .github/workflows/release-doctor.yml | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e78f00c..38c1804 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,7 +21,7 @@ jobs: runs-on: ${{ github.repository == 'stainless-sdks/coingecko-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Rye run: | @@ -46,7 +46,7 @@ jobs: id-token: write runs-on: ${{ github.repository == 'stainless-sdks/coingecko-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Rye run: | @@ -67,7 +67,7 @@ jobs: github.repository == 'stainless-sdks/coingecko-python' && !startsWith(github.ref, 'refs/heads/stl/') id: github-oidc - uses: actions/github-script@v8 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 with: script: core.setOutput('github_token', await core.getIDToken()); @@ -87,7 +87,7 @@ jobs: runs-on: ${{ github.repository == 'stainless-sdks/coingecko-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: github.event_name == 'push' || github.event.pull_request.head.repo.fork steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Rye run: | diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml index 17a446e..cc609b7 100644 --- a/.github/workflows/publish-pypi.yml +++ b/.github/workflows/publish-pypi.yml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Rye run: | diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index 426bbe4..87cc786 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -12,7 +12,7 @@ jobs: if: github.repository == 'coingecko/coingecko-python' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Check release environment run: | From 44e2ae67a350de62ced124dfb85f9c6083d57aed Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 28 May 2026 15:18:41 +0000 Subject: [PATCH 6/8] refactor!: Methods refresh --- .stats.yml | 6 +- SECURITY.md | 2 +- api.md | 181 ++-- pyproject.toml | 2 +- .../resources/asset_platforms.py | 8 +- src/coingecko_sdk/resources/coins/__init__.py | 36 +- .../resources/coins/categories.py | 16 +- .../coins/circulating_supply_chart.py | 40 +- src/coingecko_sdk/resources/coins/coins.py | 190 ++-- .../resources/coins/contract/contract.py | 14 +- .../resources/coins/contract/market_chart.py | 70 +- src/coingecko_sdk/resources/coins/history.py | 16 +- src/coingecko_sdk/resources/coins/list.py | 24 +- .../resources/coins/market_chart.py | 66 +- src/coingecko_sdk/resources/coins/markets.py | 96 +- src/coingecko_sdk/resources/coins/ohlc.py | 56 +- src/coingecko_sdk/resources/coins/tickers.py | 40 +- .../resources/coins/top_gainers_losers.py | 36 +- .../resources/coins/total_supply_chart.py | 40 +- .../resources/derivatives/derivatives.py | 10 +- .../resources/derivatives/exchanges.py | 50 +- src/coingecko_sdk/resources/entities.py | 20 +- src/coingecko_sdk/resources/exchange_rates.py | 4 +- .../resources/exchanges/exchanges.py | 38 +- .../resources/exchanges/tickers.py | 32 +- .../resources/exchanges/volume_chart.py | 28 +- .../global_/decentralized_finance_defi.py | 8 +- .../resources/global_/global_.py | 8 +- .../resources/global_/market_cap_chart.py | 20 +- src/coingecko_sdk/resources/key.py | 8 +- src/coingecko_sdk/resources/news.py | 30 +- .../resources/nfts/contract/contract.py | 10 +- .../resources/nfts/contract/market_chart.py | 16 +- .../resources/nfts/market_chart.py | 14 +- src/coingecko_sdk/resources/nfts/nfts.py | 76 +- src/coingecko_sdk/resources/nfts/tickers.py | 8 +- .../resources/onchain/categories.py | 40 +- .../resources/onchain/networks/__init__.py | 24 +- .../resources/onchain/networks/dexes.py | 46 +- .../resources/onchain/networks/networks.py | 106 ++- .../resources/onchain/networks/new_pools.py | 56 +- .../onchain/networks/pools/__init__.py | 12 +- .../resources/onchain/networks/pools/info.py | 16 +- .../resources/onchain/networks/pools/multi.py | 24 +- .../resources/onchain/networks/pools/ohlcv.py | 44 +- .../resources/onchain/networks/pools/pools.py | 104 +-- .../onchain/networks/pools/trades.py | 20 +- .../onchain/networks/tokens/__init__.py | 48 +- .../onchain/networks/tokens/holders_chart.py | 12 +- .../resources/onchain/networks/tokens/info.py | 10 +- .../onchain/networks/tokens/multi.py | 20 +- .../onchain/networks/tokens/ohlcv.py | 44 +- .../onchain/networks/tokens/pools.py | 36 +- .../onchain/networks/tokens/tokens.py | 144 +-- .../onchain/networks/tokens/top_holders.py | 18 +- .../onchain/networks/tokens/top_traders.py | 22 +- .../onchain/networks/tokens/trades.py | 12 +- .../onchain/networks/trending_pools.py | 66 +- .../resources/onchain/pools/megafilter.py | 148 +-- .../onchain/pools/trending_search.py | 20 +- .../resources/onchain/search/pools.py | 34 +- .../onchain/simple/networks/token_price.py | 34 +- .../onchain/tokens/info_recently_updated.py | 22 +- src/coingecko_sdk/resources/ping.py | 4 +- .../resources/public_treasury.py | 94 +- src/coingecko_sdk/resources/search/search.py | 10 +- .../resources/search/trending.py | 16 +- src/coingecko_sdk/resources/simple/price.py | 60 +- .../simple/supported_vs_currencies.py | 4 +- .../resources/simple/token_price.py | 40 +- src/coingecko_sdk/resources/token_lists.py | 10 +- src/coingecko_sdk/types/__init__.py | 2 - .../types/asset_platform_get_params.py | 2 +- .../types/asset_platform_get_response.py | 25 +- src/coingecko_sdk/types/coin_get_id_params.py | 20 +- .../types/coin_get_id_response.py | 852 +++++++----------- src/coingecko_sdk/types/coins/__init__.py | 1 + .../types/coins/category_get_list_response.py | 10 +- .../types/coins/category_get_params.py | 2 +- .../types/coins/category_get_response.py | 36 +- .../circulating_supply_chart_get_params.py | 4 +- ...rculating_supply_chart_get_range_params.py | 8 +- ...ulating_supply_chart_get_range_response.py | 5 +- .../circulating_supply_chart_get_response.py | 5 +- .../coins/contract/market_chart_get_params.py | 15 +- .../contract/market_chart_get_range_params.py | 17 +- .../market_chart_get_range_response.py | 11 +- .../contract/market_chart_get_response.py | 11 +- .../types/coins/contract_get_response.py | 717 ++++++--------- .../types/coins/history_get_params.py | 4 +- .../types/coins/history_get_response.py | 129 +-- .../types/coins/list_get_new_response.py | 18 +- .../types/coins/list_get_params.py | 4 +- .../types/coins/list_get_response.py | 16 +- .../types/coins/market_chart_get_params.py | 15 +- .../coins/market_chart_get_range_params.py | 17 +- .../coins/market_chart_get_range_response.py | 11 +- .../types/coins/market_chart_get_response.py | 11 +- .../types/coins/market_get_params.py | 53 +- .../types/coins/market_get_response.py | 110 ++- .../types/coins/ohlc_get_params.py | 11 +- .../types/coins/ohlc_get_range_params.py | 15 +- .../types/coins/ticker_get_params.py | 20 +- .../types/coins/ticker_get_response.py | 106 +-- .../coins/top_gainers_loser_get_params.py | 17 +- .../coins/top_gainers_loser_get_response.py | 97 +- .../types/coins/top_gainers_losers_item.py | 54 ++ .../coins/total_supply_chart_get_params.py | 4 +- .../total_supply_chart_get_range_params.py | 8 +- .../total_supply_chart_get_range_response.py | 5 +- .../coins/total_supply_chart_get_response.py | 5 +- .../types/derivative_get_response.py | 55 +- .../derivatives/exchange_get_id_params.py | 2 +- .../derivatives/exchange_get_id_response.py | 116 +-- .../derivatives/exchange_get_list_response.py | 10 +- .../types/derivatives/exchange_get_params.py | 10 +- .../derivatives/exchange_get_response.py | 42 +- .../types/detail_platform_data.py | 15 - .../types/entity_get_list_params.py | 6 +- .../types/entity_get_list_response.py | 18 +- .../types/exchange_get_id_params.py | 6 +- .../types/exchange_get_id_response.py | 187 ++-- .../types/exchange_get_list_params.py | 2 +- .../types/exchange_get_list_response.py | 10 +- .../types/exchange_get_params.py | 4 +- .../types/exchange_get_response.py | 36 +- .../types/exchange_rate_get_response.py | 21 +- .../types/exchanges/ticker_get_params.py | 22 +- .../types/exchanges/ticker_get_response.py | 106 +-- .../exchanges/volume_chart_get_params.py | 2 +- .../volume_chart_get_range_params.py | 4 +- ...decentralized_finance_defi_get_response.py | 32 +- .../global_/market_cap_chart_get_params.py | 9 +- .../global_/market_cap_chart_get_response.py | 10 +- .../types/global_get_response.py | 73 +- src/coingecko_sdk/types/key_get_response.py | 34 +- src/coingecko_sdk/types/news_get_params.py | 15 +- src/coingecko_sdk/types/news_get_response.py | 34 +- .../types/nft_get_id_response.py | 93 +- .../types/nft_get_list_params.py | 10 +- .../types/nft_get_list_response.py | 12 +- .../types/nft_get_markets_params.py | 19 +- .../types/nft_get_markets_response.py | 51 +- .../nfts/contract/market_chart_get_params.py | 2 +- .../contract/market_chart_get_response.py | 26 +- .../contract_get_contract_address_response.py | 93 +- .../types/nfts/market_chart_get_params.py | 2 +- .../types/nfts/market_chart_get_response.py | 26 +- .../types/nfts/ticker_get_response.py | 28 +- .../types/onchain/category_get_params.py | 4 +- .../onchain/category_get_pools_params.py | 11 +- .../onchain/category_get_pools_response.py | 52 +- .../types/onchain/category_get_response.py | 33 +- .../types/onchain/network_get_params.py | 2 +- .../types/onchain/network_get_response.py | 18 +- .../types/onchain/networks/__init__.py | 3 +- .../types/onchain/networks/dex_get_params.py | 2 +- .../onchain/networks/dex_get_pools_params.py | 16 +- .../networks/dex_get_pools_response.py | 67 +- .../onchain/networks/dex_get_response.py | 15 +- .../networks/new_pool_get_network_params.py | 14 +- .../networks/new_pool_get_network_response.py | 67 +- .../onchain/networks/new_pool_get_params.py | 14 +- .../onchain/networks/new_pool_get_response.py | 67 +- .../{pool_data.py => pool_address_item.py} | 190 ++-- .../networks/pool_get_address_params.py | 10 +- .../networks/pool_get_address_response.py | 5 +- .../types/onchain/networks/pool_get_params.py | 16 +- .../onchain/networks/pool_get_response.py | 67 +- .../onchain/networks/pools/info_get_params.py | 2 +- .../networks/pools/info_get_response.py | 131 ++- .../pools/multi_get_addresses_params.py | 10 +- .../pools/multi_get_addresses_response.py | 5 +- .../pools/ohlcv_get_timeframe_params.py | 23 +- .../pools/ohlcv_get_timeframe_response.py | 21 +- .../networks/pools/trade_get_params.py | 8 +- .../networks/pools/trade_get_response.py | 54 +- .../networks/token_get_address_params.py | 10 +- .../networks/token_get_address_response.py | 78 +- .../types/onchain/networks/token_item.py | 106 +++ .../tokens/holders_chart_get_params.py | 2 +- .../tokens/holders_chart_get_response.py | 21 +- .../networks/tokens/info_get_response.py | 88 +- .../tokens/multi_get_addresses_params.py | 6 +- .../tokens/multi_get_addresses_response.py | 89 +- .../tokens/ohlcv_get_timeframe_params.py | 23 +- .../tokens/ohlcv_get_timeframe_response.py | 21 +- .../networks/tokens/pool_get_params.py | 18 +- .../networks/tokens/pool_get_response.py | 83 +- .../networks/tokens/top_holder_get_params.py | 7 +- .../tokens/top_holder_get_response.py | 51 +- .../networks/tokens/top_trader_get_params.py | 9 +- .../tokens/top_trader_get_response.py | 60 +- .../networks/tokens/trade_get_params.py | 2 +- .../networks/tokens/trade_get_response.py | 60 +- .../trending_pool_get_network_params.py | 16 +- .../trending_pool_get_network_response.py | 67 +- .../networks/trending_pool_get_params.py | 17 +- .../networks/trending_pool_get_response.py | 67 +- .../onchain/pools/megafilter_get_params.py | 80 +- .../onchain/pools/megafilter_get_response.py | 67 +- .../pools/trending_search_get_params.py | 8 +- .../pools/trending_search_get_response.py | 38 +- .../types/onchain/search/pool_get_params.py | 14 +- .../types/onchain/search/pool_get_response.py | 55 +- .../token_price_get_addresses_params.py | 16 +- .../token_price_get_addresses_response.py | 22 +- .../info_recently_updated_get_params.py | 11 +- .../info_recently_updated_get_response.py | 56 +- src/coingecko_sdk/types/ping_get_response.py | 5 +- .../public_treasury_get_coin_id_params.py | 6 +- .../public_treasury_get_coin_id_response.py | 91 +- .../public_treasury_get_entity_id_params.py | 10 +- .../public_treasury_get_entity_id_response.py | 104 +-- ...ublic_treasury_get_holding_chart_params.py | 7 +- ...lic_treasury_get_holding_chart_response.py | 8 +- ...treasury_get_transaction_history_params.py | 14 +- ...easury_get_transaction_history_response.py | 36 +- .../types/search/trending_get_params.py | 7 +- .../types/search/trending_get_response.py | 199 ++-- src/coingecko_sdk/types/search_get_params.py | 2 +- .../types/search_get_response.py | 84 +- .../types/simple/price_get_params.py | 28 +- .../types/simple/price_get_response.py | 10 +- .../types/simple/token_price_get_id_params.py | 19 +- .../simple/token_price_get_id_response.py | 20 +- .../types/token_list_get_all_json_response.py | 48 +- src/coingecko_sdk/types/treasury_entity.py | 30 - .../coins/contract/test_market_chart.py | 128 +-- .../coins/test_circulating_supply_chart.py | 28 +- tests/api_resources/coins/test_contract.py | 32 +- tests/api_resources/coins/test_history.py | 16 +- .../api_resources/coins/test_market_chart.py | 72 +- tests/api_resources/coins/test_markets.py | 20 +- tests/api_resources/coins/test_ohlc.py | 64 +- tests/api_resources/coins/test_tickers.py | 20 +- .../coins/test_top_gainers_losers.py | 16 +- .../coins/test_total_supply_chart.py | 28 +- .../derivatives/test_exchanges.py | 16 +- tests/api_resources/exchanges/test_tickers.py | 16 +- .../exchanges/test_volume_chart.py | 32 +- .../global_/test_market_cap_chart.py | 4 +- .../nfts/contract/test_market_chart.py | 32 +- tests/api_resources/nfts/test_contract.py | 32 +- tests/api_resources/nfts/test_market_chart.py | 12 +- tests/api_resources/nfts/test_tickers.py | 12 +- .../onchain/networks/pools/test_info.py | 40 +- .../onchain/networks/pools/test_multi.py | 20 +- .../onchain/networks/pools/test_ohlcv.py | 40 +- .../onchain/networks/pools/test_trades.py | 40 +- .../onchain/networks/test_dexes.py | 56 +- .../onchain/networks/test_new_pools.py | 16 +- .../onchain/networks/test_pools.py | 56 +- .../onchain/networks/test_tokens.py | 40 +- .../onchain/networks/test_trending_pools.py | 16 +- .../networks/tokens/test_holders_chart.py | 40 +- .../onchain/networks/tokens/test_info.py | 32 +- .../onchain/networks/tokens/test_multi.py | 20 +- .../onchain/networks/tokens/test_ohlcv.py | 40 +- .../onchain/networks/tokens/test_pools.py | 40 +- .../networks/tokens/test_top_holders.py | 40 +- .../networks/tokens/test_top_traders.py | 40 +- .../onchain/networks/tokens/test_trades.py | 40 +- .../onchain/search/test_pools.py | 8 +- .../simple/networks/test_token_price.py | 20 +- .../api_resources/onchain/test_categories.py | 16 +- .../tokens/test_info_recently_updated.py | 4 +- .../api_resources/simple/test_token_price.py | 16 +- tests/api_resources/test_exchanges.py | 16 +- tests/api_resources/test_news.py | 8 +- tests/api_resources/test_nfts.py | 16 +- tests/api_resources/test_public_treasury.py | 96 +- tests/api_resources/test_token_lists.py | 12 +- 273 files changed, 5463 insertions(+), 5323 deletions(-) create mode 100644 src/coingecko_sdk/types/coins/top_gainers_losers_item.py delete mode 100644 src/coingecko_sdk/types/detail_platform_data.py rename src/coingecko_sdk/types/onchain/networks/{pool_data.py => pool_address_item.py} (68%) create mode 100644 src/coingecko_sdk/types/onchain/networks/token_item.py delete mode 100644 src/coingecko_sdk/types/treasury_entity.py diff --git a/.stats.yml b/.stats.yml index d24f82c..e75eb53 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 85 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/coingecko/coingecko-498a8fcd82c22d90d394dcff640d8fe35fb8f7a0deea71454364edf90d3b1baa.yml -openapi_spec_hash: 56fbbaf3608f6cde0b9ed8854fdaeb4c -config_hash: c77352c905b1a7d1ab31960e5195bddf +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/coingecko/coingecko-b079f01bc2666934105058a09411c02697a2af430c4bfbce18a007a962993b72.yml +openapi_spec_hash: 89fa5081bcee8c6dbac9e2cf7cf2257b +config_hash: 9027ea229c330039b86c690ff1bf3fce diff --git a/SECURITY.md b/SECURITY.md index 98200fa..cd14783 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -20,7 +20,7 @@ or products provided by Coingecko, please follow the respective company's securi ### Coingecko Terms and Policies -Please contact eason.lim@coingecko.com for any questions or concerns regarding the security of our services. +Please contact support@coingecko.com for any questions or concerns regarding the security of our services. --- diff --git a/api.md b/api.md index 7b0a611..3c3b49e 100644 --- a/api.md +++ b/api.md @@ -15,7 +15,7 @@ Methods: Types: ```python -from coingecko_sdk.types import DetailPlatformData, CoinGetIDResponse +from coingecko_sdk.types import CoinGetIDResponse ``` Methods: @@ -35,43 +35,6 @@ Methods: - client.coins.categories.get(\*\*params) -> CategoryGetResponse - client.coins.categories.get_list() -> CategoryGetListResponse -## List - -Types: - -```python -from coingecko_sdk.types.coins import ListGetResponse, ListGetNewResponse -``` - -Methods: - -- client.coins.list.get(\*\*params) -> ListGetResponse -- client.coins.list.get_new() -> ListGetNewResponse - -## Markets - -Types: - -```python -from coingecko_sdk.types.coins import MarketGetResponse -``` - -Methods: - -- client.coins.markets.get(\*\*params) -> MarketGetResponse - -## TopGainersLosers - -Types: - -```python -from coingecko_sdk.types.coins import TopGainersLoserGetResponse -``` - -Methods: - -- client.coins.top_gainers_losers.get(\*\*params) -> TopGainersLoserGetResponse - ## CirculatingSupplyChart Types: @@ -125,6 +88,19 @@ Methods: - client.coins.history.get(id, \*\*params) -> HistoryGetResponse +## List + +Types: + +```python +from coingecko_sdk.types.coins import ListGetResponse, ListGetNewResponse +``` + +Methods: + +- client.coins.list.get(\*\*params) -> ListGetResponse +- client.coins.list.get_new() -> ListGetNewResponse + ## MarketChart Types: @@ -138,6 +114,18 @@ Methods: - client.coins.market_chart.get(id, \*\*params) -> MarketChartGetResponse - client.coins.market_chart.get_range(id, \*\*params) -> MarketChartGetRangeResponse +## Markets + +Types: + +```python +from coingecko_sdk.types.coins import MarketGetResponse +``` + +Methods: + +- client.coins.markets.get(\*\*params) -> MarketGetResponse + ## Ohlc Types: @@ -163,6 +151,18 @@ Methods: - client.coins.tickers.get(id, \*\*params) -> TickerGetResponse +## TopGainersLosers + +Types: + +```python +from coingecko_sdk.types.coins import TopGainersLosersItem, TopGainersLoserGetResponse +``` + +Methods: + +- client.coins.top_gainers_losers.get(\*\*params) -> TopGainersLoserGetResponse + ## TotalSupplyChart Types: @@ -418,54 +418,42 @@ Methods: - client.onchain.networks.get(\*\*params) -> NetworkGetResponse -### NewPools - -Types: - -```python -from coingecko_sdk.types.onchain.networks import NewPoolGetResponse, NewPoolGetNetworkResponse -``` - -Methods: - -- client.onchain.networks.new_pools.get(\*\*params) -> NewPoolGetResponse -- client.onchain.networks.new_pools.get_network(network, \*\*params) -> NewPoolGetNetworkResponse - -### TrendingPools +### Dexes Types: ```python -from coingecko_sdk.types.onchain.networks import ( - TrendingPoolGetResponse, - TrendingPoolGetNetworkResponse, -) +from coingecko_sdk.types.onchain.networks import DexGetResponse, DexGetPoolsResponse ``` Methods: -- client.onchain.networks.trending_pools.get(\*\*params) -> TrendingPoolGetResponse -- client.onchain.networks.trending_pools.get_network(network, \*\*params) -> TrendingPoolGetNetworkResponse +- client.onchain.networks.dexes.get(network, \*\*params) -> DexGetResponse +- client.onchain.networks.dexes.get_pools(dex, \*, network, \*\*params) -> DexGetPoolsResponse -### Dexes +### NewPools Types: ```python -from coingecko_sdk.types.onchain.networks import DexGetResponse, DexGetPoolsResponse +from coingecko_sdk.types.onchain.networks import NewPoolGetResponse, NewPoolGetNetworkResponse ``` Methods: -- client.onchain.networks.dexes.get(network, \*\*params) -> DexGetResponse -- client.onchain.networks.dexes.get_pools(dex, \*, network, \*\*params) -> DexGetPoolsResponse +- client.onchain.networks.new_pools.get(\*\*params) -> NewPoolGetResponse +- client.onchain.networks.new_pools.get_network(network, \*\*params) -> NewPoolGetNetworkResponse ### Pools Types: ```python -from coingecko_sdk.types.onchain.networks import PoolData, PoolGetResponse, PoolGetAddressResponse +from coingecko_sdk.types.onchain.networks import ( + PoolAddressItem, + PoolGetResponse, + PoolGetAddressResponse, +) ``` Methods: @@ -473,29 +461,29 @@ Methods: - client.onchain.networks.pools.get(network, \*\*params) -> PoolGetResponse - client.onchain.networks.pools.get_address(address, \*, network, \*\*params) -> PoolGetAddressResponse -#### Multi +#### Info Types: ```python -from coingecko_sdk.types.onchain.networks.pools import MultiGetAddressesResponse +from coingecko_sdk.types.onchain.networks.pools import InfoGetResponse ``` Methods: -- client.onchain.networks.pools.multi.get_addresses(addresses, \*, network, \*\*params) -> MultiGetAddressesResponse +- client.onchain.networks.pools.info.get(pool_address, \*, network, \*\*params) -> InfoGetResponse -#### Info +#### Multi Types: ```python -from coingecko_sdk.types.onchain.networks.pools import InfoGetResponse +from coingecko_sdk.types.onchain.networks.pools import MultiGetAddressesResponse ``` Methods: -- client.onchain.networks.pools.info.get(pool_address, \*, network, \*\*params) -> InfoGetResponse +- client.onchain.networks.pools.multi.get_addresses(addresses, \*, network, \*\*params) -> MultiGetAddressesResponse #### Ohlcv @@ -526,24 +514,24 @@ Methods: Types: ```python -from coingecko_sdk.types.onchain.networks import TokenGetAddressResponse +from coingecko_sdk.types.onchain.networks import TokenItem, TokenGetAddressResponse ``` Methods: - client.onchain.networks.tokens.get_address(address, \*, network, \*\*params) -> TokenGetAddressResponse -#### Multi +#### HoldersChart Types: ```python -from coingecko_sdk.types.onchain.networks.tokens import MultiGetAddressesResponse +from coingecko_sdk.types.onchain.networks.tokens import HoldersChartGetResponse ``` Methods: -- client.onchain.networks.tokens.multi.get_addresses(addresses, \*, network, \*\*params) -> MultiGetAddressesResponse +- client.onchain.networks.tokens.holders_chart.get(token_address, \*, network, \*\*params) -> HoldersChartGetResponse #### Info @@ -557,53 +545,65 @@ Methods: - client.onchain.networks.tokens.info.get(address, \*, network) -> InfoGetResponse -#### TopHolders +#### Multi Types: ```python -from coingecko_sdk.types.onchain.networks.tokens import TopHolderGetResponse +from coingecko_sdk.types.onchain.networks.tokens import MultiGetAddressesResponse ``` Methods: -- client.onchain.networks.tokens.top_holders.get(address, \*, network, \*\*params) -> TopHolderGetResponse +- client.onchain.networks.tokens.multi.get_addresses(addresses, \*, network, \*\*params) -> MultiGetAddressesResponse -#### HoldersChart +#### Ohlcv Types: ```python -from coingecko_sdk.types.onchain.networks.tokens import HoldersChartGetResponse +from coingecko_sdk.types.onchain.networks.tokens import OhlcvGetTimeframeResponse ``` Methods: -- client.onchain.networks.tokens.holders_chart.get(token_address, \*, network, \*\*params) -> HoldersChartGetResponse +- client.onchain.networks.tokens.ohlcv.get_timeframe(timeframe, \*, network, token_address, \*\*params) -> OhlcvGetTimeframeResponse -#### Ohlcv +#### Pools Types: ```python -from coingecko_sdk.types.onchain.networks.tokens import OhlcvGetTimeframeResponse +from coingecko_sdk.types.onchain.networks.tokens import PoolGetResponse ``` Methods: -- client.onchain.networks.tokens.ohlcv.get_timeframe(timeframe, \*, network, token_address, \*\*params) -> OhlcvGetTimeframeResponse +- client.onchain.networks.tokens.pools.get(token_address, \*, network, \*\*params) -> PoolGetResponse -#### Pools +#### TopHolders Types: ```python -from coingecko_sdk.types.onchain.networks.tokens import PoolGetResponse +from coingecko_sdk.types.onchain.networks.tokens import TopHolderGetResponse ``` Methods: -- client.onchain.networks.tokens.pools.get(token_address, \*, network, \*\*params) -> PoolGetResponse +- client.onchain.networks.tokens.top_holders.get(address, \*, network, \*\*params) -> TopHolderGetResponse + +#### TopTraders + +Types: + +```python +from coingecko_sdk.types.onchain.networks.tokens import TopTraderGetResponse +``` + +Methods: + +- client.onchain.networks.tokens.top_traders.get(token_address, \*, network_id, \*\*params) -> TopTraderGetResponse #### Trades @@ -617,17 +617,21 @@ Methods: - client.onchain.networks.tokens.trades.get(token_address, \*, network, \*\*params) -> TradeGetResponse -#### TopTraders +### TrendingPools Types: ```python -from coingecko_sdk.types.onchain.networks.tokens import TopTraderGetResponse +from coingecko_sdk.types.onchain.networks import ( + TrendingPoolGetResponse, + TrendingPoolGetNetworkResponse, +) ``` Methods: -- client.onchain.networks.tokens.top_traders.get(token_address, \*, network_id, \*\*params) -> TopTraderGetResponse +- client.onchain.networks.trending_pools.get(\*\*params) -> TrendingPoolGetResponse +- client.onchain.networks.trending_pools.get_network(network, \*\*params) -> TrendingPoolGetNetworkResponse ## Pools @@ -717,7 +721,6 @@ Types: ```python from coingecko_sdk.types import ( - TreasuryEntity, PublicTreasuryGetCoinIDResponse, PublicTreasuryGetEntityIDResponse, PublicTreasuryGetHoldingChartResponse, diff --git a/pyproject.toml b/pyproject.toml index de2da83..0c3701c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ description = "The official Python library for the coingecko API" dynamic = ["readme"] license = "Apache-2.0" authors = [ -{ name = "Coingecko", email = "eason.lim@coingecko.com" }, +{ name = "Coingecko", email = "support@coingecko.com" }, ] dependencies = [ diff --git a/src/coingecko_sdk/resources/asset_platforms.py b/src/coingecko_sdk/resources/asset_platforms.py index aba6069..5b386ef 100644 --- a/src/coingecko_sdk/resources/asset_platforms.py +++ b/src/coingecko_sdk/resources/asset_platforms.py @@ -55,10 +55,10 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> AssetPlatformGetResponse: """ - This endpoint allows you to **query all the asset platforms on CoinGecko** + To query all the asset platforms (blockchain networks) on CoinGecko Args: - filter: apply relevant filters to results + filter: Apply relevant filters to results. extra_headers: Send extra headers @@ -113,10 +113,10 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> AssetPlatformGetResponse: """ - This endpoint allows you to **query all the asset platforms on CoinGecko** + To query all the asset platforms (blockchain networks) on CoinGecko Args: - filter: apply relevant filters to results + filter: Apply relevant filters to results. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/__init__.py b/src/coingecko_sdk/resources/coins/__init__.py index ff03951..e56695e 100644 --- a/src/coingecko_sdk/resources/coins/__init__.py +++ b/src/coingecko_sdk/resources/coins/__init__.py @@ -104,24 +104,6 @@ "AsyncCategoriesResourceWithRawResponse", "CategoriesResourceWithStreamingResponse", "AsyncCategoriesResourceWithStreamingResponse", - "ListResource", - "AsyncListResource", - "ListResourceWithRawResponse", - "AsyncListResourceWithRawResponse", - "ListResourceWithStreamingResponse", - "AsyncListResourceWithStreamingResponse", - "MarketsResource", - "AsyncMarketsResource", - "MarketsResourceWithRawResponse", - "AsyncMarketsResourceWithRawResponse", - "MarketsResourceWithStreamingResponse", - "AsyncMarketsResourceWithStreamingResponse", - "TopGainersLosersResource", - "AsyncTopGainersLosersResource", - "TopGainersLosersResourceWithRawResponse", - "AsyncTopGainersLosersResourceWithRawResponse", - "TopGainersLosersResourceWithStreamingResponse", - "AsyncTopGainersLosersResourceWithStreamingResponse", "CirculatingSupplyChartResource", "AsyncCirculatingSupplyChartResource", "CirculatingSupplyChartResourceWithRawResponse", @@ -140,12 +122,24 @@ "AsyncHistoryResourceWithRawResponse", "HistoryResourceWithStreamingResponse", "AsyncHistoryResourceWithStreamingResponse", + "ListResource", + "AsyncListResource", + "ListResourceWithRawResponse", + "AsyncListResourceWithRawResponse", + "ListResourceWithStreamingResponse", + "AsyncListResourceWithStreamingResponse", "MarketChartResource", "AsyncMarketChartResource", "MarketChartResourceWithRawResponse", "AsyncMarketChartResourceWithRawResponse", "MarketChartResourceWithStreamingResponse", "AsyncMarketChartResourceWithStreamingResponse", + "MarketsResource", + "AsyncMarketsResource", + "MarketsResourceWithRawResponse", + "AsyncMarketsResourceWithRawResponse", + "MarketsResourceWithStreamingResponse", + "AsyncMarketsResourceWithStreamingResponse", "OhlcResource", "AsyncOhlcResource", "OhlcResourceWithRawResponse", @@ -158,6 +152,12 @@ "AsyncTickersResourceWithRawResponse", "TickersResourceWithStreamingResponse", "AsyncTickersResourceWithStreamingResponse", + "TopGainersLosersResource", + "AsyncTopGainersLosersResource", + "TopGainersLosersResourceWithRawResponse", + "AsyncTopGainersLosersResourceWithRawResponse", + "TopGainersLosersResourceWithStreamingResponse", + "AsyncTopGainersLosersResourceWithStreamingResponse", "TotalSupplyChartResource", "AsyncTotalSupplyChartResource", "TotalSupplyChartResourceWithRawResponse", diff --git a/src/coingecko_sdk/resources/coins/categories.py b/src/coingecko_sdk/resources/coins/categories.py index ba4e426..f4bee1a 100644 --- a/src/coingecko_sdk/resources/coins/categories.py +++ b/src/coingecko_sdk/resources/coins/categories.py @@ -64,11 +64,11 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CategoryGetResponse: """ - This endpoint allows you to **query all the coins categories with market data - (market cap, volume, ...) on CoinGecko** + To query all the coins categories with market data (market cap, volume, etc.) on + CoinGecko Args: - order: sort results by field, default: market_cap_desc + order: Sort results by field. Default: `market_cap_desc` extra_headers: Send extra headers @@ -100,7 +100,7 @@ def get_list( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CategoryGetListResponse: - """This endpoint allows you to **query all the coins categories on CoinGecko**""" + """To query all the coins categories on CoinGecko""" return self._get( "/coins/categories/list", options=make_request_options( @@ -150,11 +150,11 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CategoryGetResponse: """ - This endpoint allows you to **query all the coins categories with market data - (market cap, volume, ...) on CoinGecko** + To query all the coins categories with market data (market cap, volume, etc.) on + CoinGecko Args: - order: sort results by field, default: market_cap_desc + order: Sort results by field. Default: `market_cap_desc` extra_headers: Send extra headers @@ -186,7 +186,7 @@ async def get_list( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CategoryGetListResponse: - """This endpoint allows you to **query all the coins categories on CoinGecko**""" + """To query all the coins categories on CoinGecko""" return await self._get( "/coins/categories/list", options=make_request_options( diff --git a/src/coingecko_sdk/resources/coins/circulating_supply_chart.py b/src/coingecko_sdk/resources/coins/circulating_supply_chart.py index d54d29e..b612ea4 100644 --- a/src/coingecko_sdk/resources/coins/circulating_supply_chart.py +++ b/src/coingecko_sdk/resources/coins/circulating_supply_chart.py @@ -58,13 +58,13 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CirculatingSupplyChartGetResponse: """ - This endpoint allows you to **query historical circulating supply of a coin by - number of days away from now based on provided coin ID** + To query historical circulating supply of a coin by number of days away from now + based on provided coin ID Args: - days: data up to number of days ago Valid values: any integer or `max` + days: Data up to number of days ago. Valid values: any integer or `max`. - interval: data interval + interval: Data interval. extra_headers: Send extra headers @@ -108,15 +108,15 @@ def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CirculatingSupplyChartGetRangeResponse: """ - This endpoint allows you to **query historical circulating supply of a coin, - within a range of timestamp based on the provided coin ID** + To query historical circulating supply of a coin, within a range of timestamp + based on the provided coin ID Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** extra_headers: Send extra headers @@ -181,13 +181,13 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CirculatingSupplyChartGetResponse: """ - This endpoint allows you to **query historical circulating supply of a coin by - number of days away from now based on provided coin ID** + To query historical circulating supply of a coin by number of days away from now + based on provided coin ID Args: - days: data up to number of days ago Valid values: any integer or `max` + days: Data up to number of days ago. Valid values: any integer or `max`. - interval: data interval + interval: Data interval. extra_headers: Send extra headers @@ -231,15 +231,15 @@ async def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CirculatingSupplyChartGetRangeResponse: """ - This endpoint allows you to **query historical circulating supply of a coin, - within a range of timestamp based on the provided coin ID** + To query historical circulating supply of a coin, within a range of timestamp + based on the provided coin ID Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/coins.py b/src/coingecko_sdk/resources/coins/coins.py index 1762df2..007fa6b 100644 --- a/src/coingecko_sdk/resources/coins/coins.py +++ b/src/coingecko_sdk/resources/coins/coins.py @@ -116,18 +116,6 @@ class CoinsResource(SyncAPIResource): def categories(self) -> CategoriesResource: return CategoriesResource(self._client) - @cached_property - def list(self) -> ListResource: - return ListResource(self._client) - - @cached_property - def markets(self) -> MarketsResource: - return MarketsResource(self._client) - - @cached_property - def top_gainers_losers(self) -> TopGainersLosersResource: - return TopGainersLosersResource(self._client) - @cached_property def circulating_supply_chart(self) -> CirculatingSupplyChartResource: return CirculatingSupplyChartResource(self._client) @@ -140,10 +128,18 @@ def contract(self) -> ContractResource: def history(self) -> HistoryResource: return HistoryResource(self._client) + @cached_property + def list(self) -> ListResource: + return ListResource(self._client) + @cached_property def market_chart(self) -> MarketChartResource: return MarketChartResource(self._client) + @cached_property + def markets(self) -> MarketsResource: + return MarketsResource(self._client) + @cached_property def ohlc(self) -> OhlcResource: return OhlcResource(self._client) @@ -152,6 +148,10 @@ def ohlc(self) -> OhlcResource: def tickers(self) -> TickersResource: return TickersResource(self._client) + @cached_property + def top_gainers_losers(self) -> TopGainersLosersResource: + return TopGainersLosersResource(self._client) + @cached_property def total_supply_chart(self) -> TotalSupplyChartResource: return TotalSupplyChartResource(self._client) @@ -195,29 +195,28 @@ def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CoinGetIDResponse: """ - This endpoint allows you to **query all the metadata (image, websites, socials, - description, contract address, etc.) and market data (price, ATH, exchange - tickers, etc.) of a coin from the CoinGecko coin page based on a particular coin - ID** + To query all the metadata (image, websites, socials, description, contract + address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin + based on a particular coin ID Args: - community_data: include community data, default: true + community_data: Include community data. Default: true - developer_data: include developer data, default: true + developer_data: Include developer data. Default: true dex_pair_format: - set to `symbol` to display DEX pair base and target as symbols, default: + Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` - include_categories_details: include categories details, default: false + include_categories_details: Include categories details. Default: false - localization: include all the localized languages in the response, default: true + localization: Include all localized languages in the response. Default: true - market_data: include market data, default: true + market_data: Include market data. Default: true - sparkline: include sparkline 7 days data, default: false + sparkline: Include sparkline 7-day data. Default: false - tickers: include tickers data, default: true + tickers: Include tickers data. Default: true extra_headers: Send extra headers @@ -259,18 +258,6 @@ class AsyncCoinsResource(AsyncAPIResource): def categories(self) -> AsyncCategoriesResource: return AsyncCategoriesResource(self._client) - @cached_property - def list(self) -> AsyncListResource: - return AsyncListResource(self._client) - - @cached_property - def markets(self) -> AsyncMarketsResource: - return AsyncMarketsResource(self._client) - - @cached_property - def top_gainers_losers(self) -> AsyncTopGainersLosersResource: - return AsyncTopGainersLosersResource(self._client) - @cached_property def circulating_supply_chart(self) -> AsyncCirculatingSupplyChartResource: return AsyncCirculatingSupplyChartResource(self._client) @@ -283,10 +270,18 @@ def contract(self) -> AsyncContractResource: def history(self) -> AsyncHistoryResource: return AsyncHistoryResource(self._client) + @cached_property + def list(self) -> AsyncListResource: + return AsyncListResource(self._client) + @cached_property def market_chart(self) -> AsyncMarketChartResource: return AsyncMarketChartResource(self._client) + @cached_property + def markets(self) -> AsyncMarketsResource: + return AsyncMarketsResource(self._client) + @cached_property def ohlc(self) -> AsyncOhlcResource: return AsyncOhlcResource(self._client) @@ -295,6 +290,10 @@ def ohlc(self) -> AsyncOhlcResource: def tickers(self) -> AsyncTickersResource: return AsyncTickersResource(self._client) + @cached_property + def top_gainers_losers(self) -> AsyncTopGainersLosersResource: + return AsyncTopGainersLosersResource(self._client) + @cached_property def total_supply_chart(self) -> AsyncTotalSupplyChartResource: return AsyncTotalSupplyChartResource(self._client) @@ -338,29 +337,28 @@ async def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CoinGetIDResponse: """ - This endpoint allows you to **query all the metadata (image, websites, socials, - description, contract address, etc.) and market data (price, ATH, exchange - tickers, etc.) of a coin from the CoinGecko coin page based on a particular coin - ID** + To query all the metadata (image, websites, socials, description, contract + address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin + based on a particular coin ID Args: - community_data: include community data, default: true + community_data: Include community data. Default: true - developer_data: include developer data, default: true + developer_data: Include developer data. Default: true dex_pair_format: - set to `symbol` to display DEX pair base and target as symbols, default: + Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` - include_categories_details: include categories details, default: false + include_categories_details: Include categories details. Default: false - localization: include all the localized languages in the response, default: true + localization: Include all localized languages in the response. Default: true - market_data: include market data, default: true + market_data: Include market data. Default: true - sparkline: include sparkline 7 days data, default: false + sparkline: Include sparkline 7-day data. Default: false - tickers: include tickers data, default: true + tickers: Include tickers data. Default: true extra_headers: Send extra headers @@ -409,18 +407,6 @@ def __init__(self, coins: CoinsResource) -> None: def categories(self) -> CategoriesResourceWithRawResponse: return CategoriesResourceWithRawResponse(self._coins.categories) - @cached_property - def list(self) -> ListResourceWithRawResponse: - return ListResourceWithRawResponse(self._coins.list) - - @cached_property - def markets(self) -> MarketsResourceWithRawResponse: - return MarketsResourceWithRawResponse(self._coins.markets) - - @cached_property - def top_gainers_losers(self) -> TopGainersLosersResourceWithRawResponse: - return TopGainersLosersResourceWithRawResponse(self._coins.top_gainers_losers) - @cached_property def circulating_supply_chart(self) -> CirculatingSupplyChartResourceWithRawResponse: return CirculatingSupplyChartResourceWithRawResponse(self._coins.circulating_supply_chart) @@ -433,10 +419,18 @@ def contract(self) -> ContractResourceWithRawResponse: def history(self) -> HistoryResourceWithRawResponse: return HistoryResourceWithRawResponse(self._coins.history) + @cached_property + def list(self) -> ListResourceWithRawResponse: + return ListResourceWithRawResponse(self._coins.list) + @cached_property def market_chart(self) -> MarketChartResourceWithRawResponse: return MarketChartResourceWithRawResponse(self._coins.market_chart) + @cached_property + def markets(self) -> MarketsResourceWithRawResponse: + return MarketsResourceWithRawResponse(self._coins.markets) + @cached_property def ohlc(self) -> OhlcResourceWithRawResponse: return OhlcResourceWithRawResponse(self._coins.ohlc) @@ -445,6 +439,10 @@ def ohlc(self) -> OhlcResourceWithRawResponse: def tickers(self) -> TickersResourceWithRawResponse: return TickersResourceWithRawResponse(self._coins.tickers) + @cached_property + def top_gainers_losers(self) -> TopGainersLosersResourceWithRawResponse: + return TopGainersLosersResourceWithRawResponse(self._coins.top_gainers_losers) + @cached_property def total_supply_chart(self) -> TotalSupplyChartResourceWithRawResponse: return TotalSupplyChartResourceWithRawResponse(self._coins.total_supply_chart) @@ -462,18 +460,6 @@ def __init__(self, coins: AsyncCoinsResource) -> None: def categories(self) -> AsyncCategoriesResourceWithRawResponse: return AsyncCategoriesResourceWithRawResponse(self._coins.categories) - @cached_property - def list(self) -> AsyncListResourceWithRawResponse: - return AsyncListResourceWithRawResponse(self._coins.list) - - @cached_property - def markets(self) -> AsyncMarketsResourceWithRawResponse: - return AsyncMarketsResourceWithRawResponse(self._coins.markets) - - @cached_property - def top_gainers_losers(self) -> AsyncTopGainersLosersResourceWithRawResponse: - return AsyncTopGainersLosersResourceWithRawResponse(self._coins.top_gainers_losers) - @cached_property def circulating_supply_chart(self) -> AsyncCirculatingSupplyChartResourceWithRawResponse: return AsyncCirculatingSupplyChartResourceWithRawResponse(self._coins.circulating_supply_chart) @@ -486,10 +472,18 @@ def contract(self) -> AsyncContractResourceWithRawResponse: def history(self) -> AsyncHistoryResourceWithRawResponse: return AsyncHistoryResourceWithRawResponse(self._coins.history) + @cached_property + def list(self) -> AsyncListResourceWithRawResponse: + return AsyncListResourceWithRawResponse(self._coins.list) + @cached_property def market_chart(self) -> AsyncMarketChartResourceWithRawResponse: return AsyncMarketChartResourceWithRawResponse(self._coins.market_chart) + @cached_property + def markets(self) -> AsyncMarketsResourceWithRawResponse: + return AsyncMarketsResourceWithRawResponse(self._coins.markets) + @cached_property def ohlc(self) -> AsyncOhlcResourceWithRawResponse: return AsyncOhlcResourceWithRawResponse(self._coins.ohlc) @@ -498,6 +492,10 @@ def ohlc(self) -> AsyncOhlcResourceWithRawResponse: def tickers(self) -> AsyncTickersResourceWithRawResponse: return AsyncTickersResourceWithRawResponse(self._coins.tickers) + @cached_property + def top_gainers_losers(self) -> AsyncTopGainersLosersResourceWithRawResponse: + return AsyncTopGainersLosersResourceWithRawResponse(self._coins.top_gainers_losers) + @cached_property def total_supply_chart(self) -> AsyncTotalSupplyChartResourceWithRawResponse: return AsyncTotalSupplyChartResourceWithRawResponse(self._coins.total_supply_chart) @@ -515,18 +513,6 @@ def __init__(self, coins: CoinsResource) -> None: def categories(self) -> CategoriesResourceWithStreamingResponse: return CategoriesResourceWithStreamingResponse(self._coins.categories) - @cached_property - def list(self) -> ListResourceWithStreamingResponse: - return ListResourceWithStreamingResponse(self._coins.list) - - @cached_property - def markets(self) -> MarketsResourceWithStreamingResponse: - return MarketsResourceWithStreamingResponse(self._coins.markets) - - @cached_property - def top_gainers_losers(self) -> TopGainersLosersResourceWithStreamingResponse: - return TopGainersLosersResourceWithStreamingResponse(self._coins.top_gainers_losers) - @cached_property def circulating_supply_chart(self) -> CirculatingSupplyChartResourceWithStreamingResponse: return CirculatingSupplyChartResourceWithStreamingResponse(self._coins.circulating_supply_chart) @@ -539,10 +525,18 @@ def contract(self) -> ContractResourceWithStreamingResponse: def history(self) -> HistoryResourceWithStreamingResponse: return HistoryResourceWithStreamingResponse(self._coins.history) + @cached_property + def list(self) -> ListResourceWithStreamingResponse: + return ListResourceWithStreamingResponse(self._coins.list) + @cached_property def market_chart(self) -> MarketChartResourceWithStreamingResponse: return MarketChartResourceWithStreamingResponse(self._coins.market_chart) + @cached_property + def markets(self) -> MarketsResourceWithStreamingResponse: + return MarketsResourceWithStreamingResponse(self._coins.markets) + @cached_property def ohlc(self) -> OhlcResourceWithStreamingResponse: return OhlcResourceWithStreamingResponse(self._coins.ohlc) @@ -551,6 +545,10 @@ def ohlc(self) -> OhlcResourceWithStreamingResponse: def tickers(self) -> TickersResourceWithStreamingResponse: return TickersResourceWithStreamingResponse(self._coins.tickers) + @cached_property + def top_gainers_losers(self) -> TopGainersLosersResourceWithStreamingResponse: + return TopGainersLosersResourceWithStreamingResponse(self._coins.top_gainers_losers) + @cached_property def total_supply_chart(self) -> TotalSupplyChartResourceWithStreamingResponse: return TotalSupplyChartResourceWithStreamingResponse(self._coins.total_supply_chart) @@ -568,18 +566,6 @@ def __init__(self, coins: AsyncCoinsResource) -> None: def categories(self) -> AsyncCategoriesResourceWithStreamingResponse: return AsyncCategoriesResourceWithStreamingResponse(self._coins.categories) - @cached_property - def list(self) -> AsyncListResourceWithStreamingResponse: - return AsyncListResourceWithStreamingResponse(self._coins.list) - - @cached_property - def markets(self) -> AsyncMarketsResourceWithStreamingResponse: - return AsyncMarketsResourceWithStreamingResponse(self._coins.markets) - - @cached_property - def top_gainers_losers(self) -> AsyncTopGainersLosersResourceWithStreamingResponse: - return AsyncTopGainersLosersResourceWithStreamingResponse(self._coins.top_gainers_losers) - @cached_property def circulating_supply_chart(self) -> AsyncCirculatingSupplyChartResourceWithStreamingResponse: return AsyncCirculatingSupplyChartResourceWithStreamingResponse(self._coins.circulating_supply_chart) @@ -592,10 +578,18 @@ def contract(self) -> AsyncContractResourceWithStreamingResponse: def history(self) -> AsyncHistoryResourceWithStreamingResponse: return AsyncHistoryResourceWithStreamingResponse(self._coins.history) + @cached_property + def list(self) -> AsyncListResourceWithStreamingResponse: + return AsyncListResourceWithStreamingResponse(self._coins.list) + @cached_property def market_chart(self) -> AsyncMarketChartResourceWithStreamingResponse: return AsyncMarketChartResourceWithStreamingResponse(self._coins.market_chart) + @cached_property + def markets(self) -> AsyncMarketsResourceWithStreamingResponse: + return AsyncMarketsResourceWithStreamingResponse(self._coins.markets) + @cached_property def ohlc(self) -> AsyncOhlcResourceWithStreamingResponse: return AsyncOhlcResourceWithStreamingResponse(self._coins.ohlc) @@ -604,6 +598,10 @@ def ohlc(self) -> AsyncOhlcResourceWithStreamingResponse: def tickers(self) -> AsyncTickersResourceWithStreamingResponse: return AsyncTickersResourceWithStreamingResponse(self._coins.tickers) + @cached_property + def top_gainers_losers(self) -> AsyncTopGainersLosersResourceWithStreamingResponse: + return AsyncTopGainersLosersResourceWithStreamingResponse(self._coins.top_gainers_losers) + @cached_property def total_supply_chart(self) -> AsyncTotalSupplyChartResourceWithStreamingResponse: return AsyncTotalSupplyChartResourceWithStreamingResponse(self._coins.total_supply_chart) diff --git a/src/coingecko_sdk/resources/coins/contract/contract.py b/src/coingecko_sdk/resources/coins/contract/contract.py index c933d07..cccdfc9 100644 --- a/src/coingecko_sdk/resources/coins/contract/contract.py +++ b/src/coingecko_sdk/resources/coins/contract/contract.py @@ -65,10 +65,9 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ContractGetResponse: """ - This endpoint allows you to **query all the metadata (image, websites, socials, - description, contract address, etc.) and market data (price, ATH, exchange - tickers, etc.) of a coin from the CoinGecko coin page based on an asset platform - and a particular token contract address** + To query all the metadata (image, websites, socials, description, contract + address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin + based on an asset platform and a particular token contract address Args: extra_headers: Send extra headers @@ -129,10 +128,9 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ContractGetResponse: """ - This endpoint allows you to **query all the metadata (image, websites, socials, - description, contract address, etc.) and market data (price, ATH, exchange - tickers, etc.) of a coin from the CoinGecko coin page based on an asset platform - and a particular token contract address** + To query all the metadata (image, websites, socials, description, contract + address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin + based on an asset platform and a particular token contract address Args: extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/contract/market_chart.py b/src/coingecko_sdk/resources/coins/contract/market_chart.py index f151bc6..dd03812 100644 --- a/src/coingecko_sdk/resources/coins/contract/market_chart.py +++ b/src/coingecko_sdk/resources/coins/contract/market_chart.py @@ -83,20 +83,19 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetResponse: """ - This endpoint allows you to **get the historical chart data including time in - UNIX, price, market cap and 24hr volume based on asset platform and particular - token contract address** + To get the historical chart data including time in UNIX, price, market cap and + 24hrs volume based on asset platform and particular token contract address Args: - days: data up to number of days ago You may use any integer or `max` for number of - days + days: Data up to number of days ago. You may use any integer or `max` for number of + days. - vs_currency: target currency of market data \\**refers to + vs_currency: Target currency of market data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers @@ -172,23 +171,23 @@ def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetRangeResponse: """ - This endpoint allows you to **get the historical chart data within certain time - range in UNIX along with price, market cap and 24hr volume based on asset - platform and particular token contract address** + To get the historical chart data within certain time range in UNIX along with + price, market cap and 24hrs volume based on asset platform and particular token + contract address Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - vs_currency: target currency of market data \\**refers to + vs_currency: Target currency of market data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers @@ -285,20 +284,19 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetResponse: """ - This endpoint allows you to **get the historical chart data including time in - UNIX, price, market cap and 24hr volume based on asset platform and particular - token contract address** + To get the historical chart data including time in UNIX, price, market cap and + 24hrs volume based on asset platform and particular token contract address Args: - days: data up to number of days ago You may use any integer or `max` for number of - days + days: Data up to number of days ago. You may use any integer or `max` for number of + days. - vs_currency: target currency of market data \\**refers to + vs_currency: Target currency of market data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers @@ -374,23 +372,23 @@ async def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetRangeResponse: """ - This endpoint allows you to **get the historical chart data within certain time - range in UNIX along with price, market cap and 24hr volume based on asset - platform and particular token contract address** + To get the historical chart data within certain time range in UNIX along with + price, market cap and 24hrs volume based on asset platform and particular token + contract address Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - vs_currency: target currency of market data \\**refers to + vs_currency: Target currency of market data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/history.py b/src/coingecko_sdk/resources/coins/history.py index 4196184..a5bc39c 100644 --- a/src/coingecko_sdk/resources/coins/history.py +++ b/src/coingecko_sdk/resources/coins/history.py @@ -55,13 +55,13 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> HistoryGetResponse: """ - This endpoint allows you to **query the historical data (price, market cap, - 24hrs volume, ...) at a given date for a coin based on a particular coin ID** + To query the historical data (price, market cap, 24hrs volume, etc.) at a given + date for a coin based on a particular coin ID Args: - date: date of data snapshot (`YYYY-MM-DD`) + date: The date of data snapshot. Format: `YYYY-MM-DD` - localization: include all the localized languages in response, default: true + localization: Include all the localized languages in response. Default: true extra_headers: Send extra headers @@ -126,13 +126,13 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> HistoryGetResponse: """ - This endpoint allows you to **query the historical data (price, market cap, - 24hrs volume, ...) at a given date for a coin based on a particular coin ID** + To query the historical data (price, market cap, 24hrs volume, etc.) at a given + date for a coin based on a particular coin ID Args: - date: date of data snapshot (`YYYY-MM-DD`) + date: The date of data snapshot. Format: `YYYY-MM-DD` - localization: include all the localized languages in response, default: true + localization: Include all the localized languages in response. Default: true extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/list.py b/src/coingecko_sdk/resources/coins/list.py index bda168b..a76f690 100644 --- a/src/coingecko_sdk/resources/coins/list.py +++ b/src/coingecko_sdk/resources/coins/list.py @@ -57,13 +57,12 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ListGetResponse: """ - This endpoint allows you to **query all the supported coins on CoinGecko with - coins ID, name and symbol** + To query all the supported coins on CoinGecko with coin ID, name and symbol Args: - include_platform: include platform and token's contract addresses, default: false + include_platform: Include platform and token's contract addresses. Default: false - status: filter by status of coins, default: active + status: Filter by status of coins. Default: active extra_headers: Send extra headers @@ -101,10 +100,7 @@ def get_new( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ListGetNewResponse: - """ - This endpoint allows you to **query the latest 200 coins that recently listed on - CoinGecko** - """ + """To query the latest 200 coins that recently listed on CoinGecko""" return self._get( "/coins/list/new", options=make_request_options( @@ -147,13 +143,12 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ListGetResponse: """ - This endpoint allows you to **query all the supported coins on CoinGecko with - coins ID, name and symbol** + To query all the supported coins on CoinGecko with coin ID, name and symbol Args: - include_platform: include platform and token's contract addresses, default: false + include_platform: Include platform and token's contract addresses. Default: false - status: filter by status of coins, default: active + status: Filter by status of coins. Default: active extra_headers: Send extra headers @@ -191,10 +186,7 @@ async def get_new( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ListGetNewResponse: - """ - This endpoint allows you to **query the latest 200 coins that recently listed on - CoinGecko** - """ + """To query the latest 200 coins that recently listed on CoinGecko""" return await self._get( "/coins/list/new", options=make_request_options( diff --git a/src/coingecko_sdk/resources/coins/market_chart.py b/src/coingecko_sdk/resources/coins/market_chart.py index bb49a1e..b70fff4 100644 --- a/src/coingecko_sdk/resources/coins/market_chart.py +++ b/src/coingecko_sdk/resources/coins/market_chart.py @@ -82,19 +82,19 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetResponse: """ - This endpoint allows you to **get the historical chart data of a coin including - time in UNIX, price, market cap and 24hr volume based on particular coin ID** + To get the historical chart data of a coin including time in UNIX, price, market + cap and 24hrs volume based on particular coin ID Args: - days: data up to number of days ago You may use any integer or `max` for number of - days + days: Data up to number of days ago. You may use any integer or `max` for number of + days. - vs_currency: target currency of market data \\**refers to + vs_currency: Target currency of market data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers @@ -165,23 +165,22 @@ def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetRangeResponse: """ - This endpoint allows you to **get the historical chart data of a coin within - certain time range in UNIX along with price, market cap and 24hr volume based on - particular coin ID** + To get the historical chart data of a coin within certain time range in UNIX + along with price, market cap and 24hrs volume based on particular coin ID Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - vs_currency: target currency of market data \\**refers to + vs_currency: Target currency of market data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers @@ -273,19 +272,19 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetResponse: """ - This endpoint allows you to **get the historical chart data of a coin including - time in UNIX, price, market cap and 24hr volume based on particular coin ID** + To get the historical chart data of a coin including time in UNIX, price, market + cap and 24hrs volume based on particular coin ID Args: - days: data up to number of days ago You may use any integer or `max` for number of - days + days: Data up to number of days ago. You may use any integer or `max` for number of + days. - vs_currency: target currency of market data \\**refers to + vs_currency: Target currency of market data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers @@ -356,23 +355,22 @@ async def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetRangeResponse: """ - This endpoint allows you to **get the historical chart data of a coin within - certain time range in UNIX along with price, market cap and 24hr volume based on - particular coin ID** + To get the historical chart data of a coin within certain time range in UNIX + along with price, market cap and 24hrs volume based on particular coin ID Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - vs_currency: target currency of market data \\**refers to + vs_currency: Target currency of market data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/markets.py b/src/coingecko_sdk/resources/coins/markets.py index 0d1700a..5ead47c 100644 --- a/src/coingecko_sdk/resources/coins/markets.py +++ b/src/coingecko_sdk/resources/coins/markets.py @@ -91,8 +91,8 @@ def get( names: str | Omit = omit, order: Literal["market_cap_asc", "market_cap_desc", "volume_asc", "volume_desc", "id_asc", "id_desc"] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, precision: Literal[ "full", "0", @@ -127,43 +127,43 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketGetResponse: """ - This endpoint allows you to **query all the supported coins with price, market - cap, volume and market related data** + To query all the supported coins with price, market cap, volume and market + related data Args: - vs_currency: target currency of coins and market data \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + vs_currency: Target currency of coins and market data. \\**refers to + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) - category: filter based on coins' category \\**refers to - [`/coins/categories/list`](/reference/coins-categories-list). + category: Filter based on coins' category. \\**refers to + [`/coins/categories/list`](/reference/coins-categories-list) - ids: coins' IDs, comma-separated if querying more than 1 coin. \\**refers to - [`/coins/list`](/reference/coins-list). + ids: Coins' IDs, comma-separated if querying more than 1 coin. \\**refers to + [`/coins/list`](/reference/coins-list) - include_rehypothecated: include rehypothecated tokens in results, default: false When true, returns - `market_cap_rank_with_rehypothecated` field + include_rehypothecated: Include rehypothecated tokens in results. When true, returns + `market_cap_rank_with_rehypothecated` field. Default: false - include_tokens: for `symbols` lookups, specify `all` to include all matching tokens Default - `top` returns top-ranked tokens (by market cap or volume) + include_tokens: For `symbols` lookups, specify `all` to include all matching tokens. Default + `top` returns top-ranked tokens by market cap or volume. - locale: language background, default: en + locale: Language background. Default: en - names: coins' names, comma-separated if querying more than 1 coin. + names: Coins' names, comma-separated if querying more than 1 coin. - order: sort result by field, default: market_cap_desc + order: Sort result by field. Default: market_cap_desc - page: page through results, default: 1 + page: Page through results. Default: 1 - per_page: total results per page, default: 100 Valid values: 1...250 + per_page: Total results per page. Default: 100 Valid values: 1...250 - precision: decimal place for currency price value + precision: Decimal places for currency price value - price_change_percentage: include price change percentage timeframe, comma-separated if query more than 1 - timeframe Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y + price_change_percentage: Include price change percentage timeframe, comma-separated if querying more than + 1 timeframe. Valid values: `1h`, `24h`, `7d`, `14d`, `30d`, `200d`, `1y` - sparkline: include sparkline 7 days data, default: false + sparkline: Include sparkline 7-day data. Default: false - symbols: coins' symbols, comma-separated if querying more than 1 coin. + symbols: Coins' symbols, comma-separated if querying more than 1 coin. extra_headers: Send extra headers @@ -272,8 +272,8 @@ async def get( names: str | Omit = omit, order: Literal["market_cap_asc", "market_cap_desc", "volume_asc", "volume_desc", "id_asc", "id_desc"] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, precision: Literal[ "full", "0", @@ -308,43 +308,43 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketGetResponse: """ - This endpoint allows you to **query all the supported coins with price, market - cap, volume and market related data** + To query all the supported coins with price, market cap, volume and market + related data Args: - vs_currency: target currency of coins and market data \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + vs_currency: Target currency of coins and market data. \\**refers to + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) - category: filter based on coins' category \\**refers to - [`/coins/categories/list`](/reference/coins-categories-list). + category: Filter based on coins' category. \\**refers to + [`/coins/categories/list`](/reference/coins-categories-list) - ids: coins' IDs, comma-separated if querying more than 1 coin. \\**refers to - [`/coins/list`](/reference/coins-list). + ids: Coins' IDs, comma-separated if querying more than 1 coin. \\**refers to + [`/coins/list`](/reference/coins-list) - include_rehypothecated: include rehypothecated tokens in results, default: false When true, returns - `market_cap_rank_with_rehypothecated` field + include_rehypothecated: Include rehypothecated tokens in results. When true, returns + `market_cap_rank_with_rehypothecated` field. Default: false - include_tokens: for `symbols` lookups, specify `all` to include all matching tokens Default - `top` returns top-ranked tokens (by market cap or volume) + include_tokens: For `symbols` lookups, specify `all` to include all matching tokens. Default + `top` returns top-ranked tokens by market cap or volume. - locale: language background, default: en + locale: Language background. Default: en - names: coins' names, comma-separated if querying more than 1 coin. + names: Coins' names, comma-separated if querying more than 1 coin. - order: sort result by field, default: market_cap_desc + order: Sort result by field. Default: market_cap_desc - page: page through results, default: 1 + page: Page through results. Default: 1 - per_page: total results per page, default: 100 Valid values: 1...250 + per_page: Total results per page. Default: 100 Valid values: 1...250 - precision: decimal place for currency price value + precision: Decimal places for currency price value - price_change_percentage: include price change percentage timeframe, comma-separated if query more than 1 - timeframe Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y + price_change_percentage: Include price change percentage timeframe, comma-separated if querying more than + 1 timeframe. Valid values: `1h`, `24h`, `7d`, `14d`, `30d`, `200d`, `1y` - sparkline: include sparkline 7 days data, default: false + sparkline: Include sparkline 7-day data. Default: false - symbols: coins' symbols, comma-separated if querying more than 1 coin. + symbols: Coins' symbols, comma-separated if querying more than 1 coin. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/ohlc.py b/src/coingecko_sdk/resources/coins/ohlc.py index 8154177..9278b27 100644 --- a/src/coingecko_sdk/resources/coins/ohlc.py +++ b/src/coingecko_sdk/resources/coins/ohlc.py @@ -82,18 +82,18 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> OhlcGetResponse: """ - This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a - coin based on particular coin ID** + To get the OHLC chart (Open, High, Low, Close) of a coin based on particular + coin ID Args: - days: data up to number of days ago + days: Data up to number of days ago. - vs_currency: target currency of price data \\**refers to + vs_currency: Target currency of price data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers @@ -141,19 +141,19 @@ def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> OhlcGetRangeResponse: """ - This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a - coin within a range of timestamp based on particular coin ID** + To get the OHLC chart (Open, High, Low, Close) of a coin within a range of + timestamp based on particular coin ID Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - interval: data interval + interval: Data interval. - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - vs_currency: target currency of price data \\**refers to + vs_currency: Target currency of price data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). extra_headers: Send extra headers @@ -245,18 +245,18 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> OhlcGetResponse: """ - This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a - coin based on particular coin ID** + To get the OHLC chart (Open, High, Low, Close) of a coin based on particular + coin ID Args: - days: data up to number of days ago + days: Data up to number of days ago. - vs_currency: target currency of price data \\**refers to + vs_currency: Target currency of price data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). - interval: data interval, leave empty for auto granularity + interval: Data interval, leave empty for auto granularity. - precision: decimal place for currency price value + precision: Decimal place for currency price value. extra_headers: Send extra headers @@ -304,19 +304,19 @@ async def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> OhlcGetRangeResponse: """ - This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a - coin within a range of timestamp based on particular coin ID** + To get the OHLC chart (Open, High, Low, Close) of a coin within a range of + timestamp based on particular coin ID Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - interval: data interval + interval: Data interval. - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - vs_currency: target currency of price data \\**refers to + vs_currency: Target currency of price data. \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/tickers.py b/src/coingecko_sdk/resources/coins/tickers.py index 67d2ebd..ccd407c 100644 --- a/src/coingecko_sdk/resources/coins/tickers.py +++ b/src/coingecko_sdk/resources/coins/tickers.py @@ -52,7 +52,7 @@ def get( exchange_ids: str | Omit = omit, include_exchange_logo: bool | Omit = omit, order: Literal["trust_score_desc", "trust_score_asc", "volume_desc", "volume_asc"] | Omit = omit, - page: float | Omit = omit, + page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -61,24 +61,24 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TickerGetResponse: """ - This endpoint allows you to **query the coin tickers on both centralized - exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID** + To query the coin tickers on both centralized exchange (CEX) and decentralized + exchange (DEX) based on a particular coin ID Args: - depth: include 2% orderbook depth, ie. `cost_to_move_up_usd` and - `cost_to_move_down_usd` Default: false + depth: Include 2% orderbook depth, i.e. `cost_to_move_up_usd` and + `cost_to_move_down_usd`. Default: false dex_pair_format: - set to `symbol` to display DEX pair base and target as symbols, default: + Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` - exchange_ids: exchange ID \\**refers to [`/exchanges/list`](/reference/exchanges-list). + exchange_ids: Exchange ID. \\**refers to [`/exchanges/list`](/reference/exchanges-list) - include_exchange_logo: include exchange logo, default: false + include_exchange_logo: Include exchange logo. Default: false - order: use this to sort the order of responses, default: trust_score_desc + order: Sort the order of responses. Default: trust_score_desc - page: page through results + page: Page through results extra_headers: Send extra headers @@ -142,7 +142,7 @@ async def get( exchange_ids: str | Omit = omit, include_exchange_logo: bool | Omit = omit, order: Literal["trust_score_desc", "trust_score_asc", "volume_desc", "volume_asc"] | Omit = omit, - page: float | Omit = omit, + page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -151,24 +151,24 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TickerGetResponse: """ - This endpoint allows you to **query the coin tickers on both centralized - exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID** + To query the coin tickers on both centralized exchange (CEX) and decentralized + exchange (DEX) based on a particular coin ID Args: - depth: include 2% orderbook depth, ie. `cost_to_move_up_usd` and - `cost_to_move_down_usd` Default: false + depth: Include 2% orderbook depth, i.e. `cost_to_move_up_usd` and + `cost_to_move_down_usd`. Default: false dex_pair_format: - set to `symbol` to display DEX pair base and target as symbols, default: + Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` - exchange_ids: exchange ID \\**refers to [`/exchanges/list`](/reference/exchanges-list). + exchange_ids: Exchange ID. \\**refers to [`/exchanges/list`](/reference/exchanges-list) - include_exchange_logo: include exchange logo, default: false + include_exchange_logo: Include exchange logo. Default: false - order: use this to sort the order of responses, default: trust_score_desc + order: Sort the order of responses. Default: trust_score_desc - page: page through results + page: Page through results extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/top_gainers_losers.py b/src/coingecko_sdk/resources/coins/top_gainers_losers.py index b2c24ed..a97db35 100644 --- a/src/coingecko_sdk/resources/coins/top_gainers_losers.py +++ b/src/coingecko_sdk/resources/coins/top_gainers_losers.py @@ -58,20 +58,20 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TopGainersLoserGetResponse: """ - This endpoint allows you to **query the top 30 coins with largest price gain and - loss by a specific time duration** + To query the top 30 coins with largest price gain and loss by a specific time + duration Args: - vs_currency: target currency of coins \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + vs_currency: Target currency of coins. \\**refers to + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) - duration: filter result by time range Default value: `24h` + duration: Filter result by time range. Default: `24h` - price_change_percentage: include price change percentage timeframe, comma-separated if query more than 1 - price change percentage timeframe Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y + price_change_percentage: Include price change percentage timeframe, comma-separated if querying more than + 1 timeframe. Valid values: `1h`, `24h`, `7d`, `14d`, `30d`, `60d`, `200d`, `1y` - top_coins: filter result by market cap ranking (top 300 to 1000) or all coins (including - coins that do not have market cap) Default value: `1000` + top_coins: Filter result by market cap ranking (top 300 to 1000) or all coins (including + coins that do not have market cap). Default: `1000` extra_headers: Send extra headers @@ -137,20 +137,20 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TopGainersLoserGetResponse: """ - This endpoint allows you to **query the top 30 coins with largest price gain and - loss by a specific time duration** + To query the top 30 coins with largest price gain and loss by a specific time + duration Args: - vs_currency: target currency of coins \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + vs_currency: Target currency of coins. \\**refers to + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) - duration: filter result by time range Default value: `24h` + duration: Filter result by time range. Default: `24h` - price_change_percentage: include price change percentage timeframe, comma-separated if query more than 1 - price change percentage timeframe Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y + price_change_percentage: Include price change percentage timeframe, comma-separated if querying more than + 1 timeframe. Valid values: `1h`, `24h`, `7d`, `14d`, `30d`, `60d`, `200d`, `1y` - top_coins: filter result by market cap ranking (top 300 to 1000) or all coins (including - coins that do not have market cap) Default value: `1000` + top_coins: Filter result by market cap ranking (top 300 to 1000) or all coins (including + coins that do not have market cap). Default: `1000` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/coins/total_supply_chart.py b/src/coingecko_sdk/resources/coins/total_supply_chart.py index 85f5ec1..e280b55 100644 --- a/src/coingecko_sdk/resources/coins/total_supply_chart.py +++ b/src/coingecko_sdk/resources/coins/total_supply_chart.py @@ -58,13 +58,13 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TotalSupplyChartGetResponse: """ - This endpoint allows you to **query historical total supply of a coin by number - of days away from now based on provided coin ID** + To query historical total supply of a coin by number of days away from now based + on provided coin ID Args: - days: data up to number of days ago Valid values: any integer or `max` + days: Data up to number of days ago. Valid values: any integer or `max`. - interval: data interval + interval: Data interval. extra_headers: Send extra headers @@ -108,15 +108,15 @@ def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TotalSupplyChartGetRangeResponse: """ - This endpoint allows you to **query historical total supply of a coin, within a - range of timestamp based on the provided coin ID** + To query historical total supply of a coin, within a range of timestamp based on + the provided coin ID Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** extra_headers: Send extra headers @@ -181,13 +181,13 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TotalSupplyChartGetResponse: """ - This endpoint allows you to **query historical total supply of a coin by number - of days away from now based on provided coin ID** + To query historical total supply of a coin by number of days away from now based + on provided coin ID Args: - days: data up to number of days ago Valid values: any integer or `max` + days: Data up to number of days ago. Valid values: any integer or `max`. - interval: data interval + interval: Data interval. extra_headers: Send extra headers @@ -231,15 +231,15 @@ async def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TotalSupplyChartGetRangeResponse: """ - This endpoint allows you to **query historical total supply of a coin, within a - range of timestamp based on the provided coin ID** + To query historical total supply of a coin, within a range of timestamp based on + the provided coin ID Args: - from_: starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + from_: Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** - to: ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + to: Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/derivatives/derivatives.py b/src/coingecko_sdk/resources/derivatives/derivatives.py index 864fa18..d6de218 100644 --- a/src/coingecko_sdk/resources/derivatives/derivatives.py +++ b/src/coingecko_sdk/resources/derivatives/derivatives.py @@ -61,10 +61,7 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> DerivativeGetResponse: - """ - This endpoint allows you to **query all the tickers from derivatives exchanges - on CoinGecko** - """ + """To query all the tickers from derivatives exchanges on CoinGecko""" return self._get( "/derivatives", options=make_request_options( @@ -108,10 +105,7 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> DerivativeGetResponse: - """ - This endpoint allows you to **query all the tickers from derivatives exchanges - on CoinGecko** - """ + """To query all the tickers from derivatives exchanges on CoinGecko""" return await self._get( "/derivatives", options=make_request_options( diff --git a/src/coingecko_sdk/resources/derivatives/exchanges.py b/src/coingecko_sdk/resources/derivatives/exchanges.py index 419ff81..43b6765 100644 --- a/src/coingecko_sdk/resources/derivatives/exchanges.py +++ b/src/coingecko_sdk/resources/derivatives/exchanges.py @@ -57,8 +57,8 @@ def get( "trade_volume_24h_btc_desc", ] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -67,15 +67,15 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetResponse: """ - This endpoint allows you to **query all the derivatives exchanges with related - data (ID, name, open interest, ...) on CoinGecko** + To query all the derivatives exchanges with related data (ID, name, open + interest, ...) on CoinGecko Args: - order: use this to sort the order of responses, default: open_interest_btc_desc + order: Sort order of responses. Default: `open_interest_btc_desc` - page: page through results, default: 1 + page: Page through results. Default value: 1 - per_page: total results per page + per_page: Total results per page. extra_headers: Send extra headers @@ -117,11 +117,11 @@ def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetIDResponse: """ - This endpoint allows you to **query the derivatives exchange's related data (ID, - name, open interest, ...) based on the exchanges' ID** + To query the derivatives exchange's related data (name, open interest, trade + volume, ...) based on the exchange's ID Args: - include_tickers: include tickers data + include_tickers: Include tickers data. Default: tickers data is not included. extra_headers: Send extra headers @@ -155,10 +155,7 @@ def get_list( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetListResponse: - """ - This endpoint allows you to **query all the derivatives exchanges with ID and - name on CoinGecko** - """ + """To query all the derivatives exchanges with ID and name on CoinGecko""" return self._get( "/derivatives/exchanges/list", options=make_request_options( @@ -200,8 +197,8 @@ async def get( "trade_volume_24h_btc_desc", ] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -210,15 +207,15 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetResponse: """ - This endpoint allows you to **query all the derivatives exchanges with related - data (ID, name, open interest, ...) on CoinGecko** + To query all the derivatives exchanges with related data (ID, name, open + interest, ...) on CoinGecko Args: - order: use this to sort the order of responses, default: open_interest_btc_desc + order: Sort order of responses. Default: `open_interest_btc_desc` - page: page through results, default: 1 + page: Page through results. Default value: 1 - per_page: total results per page + per_page: Total results per page. extra_headers: Send extra headers @@ -260,11 +257,11 @@ async def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetIDResponse: """ - This endpoint allows you to **query the derivatives exchange's related data (ID, - name, open interest, ...) based on the exchanges' ID** + To query the derivatives exchange's related data (name, open interest, trade + volume, ...) based on the exchange's ID Args: - include_tickers: include tickers data + include_tickers: Include tickers data. Default: tickers data is not included. extra_headers: Send extra headers @@ -300,10 +297,7 @@ async def get_list( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetListResponse: - """ - This endpoint allows you to **query all the derivatives exchanges with ID and - name on CoinGecko** - """ + """To query all the derivatives exchanges with ID and name on CoinGecko""" return await self._get( "/derivatives/exchanges/list", options=make_request_options( diff --git a/src/coingecko_sdk/resources/entities.py b/src/coingecko_sdk/resources/entities.py index 3c85dd2..bcf50f4 100644 --- a/src/coingecko_sdk/resources/entities.py +++ b/src/coingecko_sdk/resources/entities.py @@ -57,15 +57,15 @@ def get_list( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> EntityGetListResponse: """ - This endpoint allows you to **query all the supported entities on CoinGecko with - entities ID, name, symbol, and country** + To query all the supported entities on CoinGecko with entity ID, name, symbol, + and country Args: - entity_type: filter by entity type, default: false + entity_type: Filter by entity type. - page: page through results, default: 1 + page: Page through results. Default value: 1 - per_page: total results per page, default: 100 Valid values: 1...250 + per_page: Total results per page. Default value: 100 Valid values: 1...250 extra_headers: Send extra headers @@ -129,15 +129,15 @@ async def get_list( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> EntityGetListResponse: """ - This endpoint allows you to **query all the supported entities on CoinGecko with - entities ID, name, symbol, and country** + To query all the supported entities on CoinGecko with entity ID, name, symbol, + and country Args: - entity_type: filter by entity type, default: false + entity_type: Filter by entity type. - page: page through results, default: 1 + page: Page through results. Default value: 1 - per_page: total results per page, default: 100 Valid values: 1...250 + per_page: Total results per page. Default value: 100 Valid values: 1...250 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/exchange_rates.py b/src/coingecko_sdk/resources/exchange_rates.py index 42a5041..1baa810 100644 --- a/src/coingecko_sdk/resources/exchange_rates.py +++ b/src/coingecko_sdk/resources/exchange_rates.py @@ -49,7 +49,7 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeRateGetResponse: - """This endpoint allows you to **query BTC exchange rates with other currencies**""" + """To query BTC exchange rates with other currencies""" return self._get( "/exchange_rates", options=make_request_options( @@ -89,7 +89,7 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeRateGetResponse: - """This endpoint allows you to **query BTC exchange rates with other currencies**""" + """To query BTC exchange rates with other currencies""" return await self._get( "/exchange_rates", options=make_request_options( diff --git a/src/coingecko_sdk/resources/exchanges/exchanges.py b/src/coingecko_sdk/resources/exchanges/exchanges.py index 3701569..774b1de 100644 --- a/src/coingecko_sdk/resources/exchanges/exchanges.py +++ b/src/coingecko_sdk/resources/exchanges/exchanges.py @@ -82,13 +82,13 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetResponse: """ - This endpoint allows you to **query all the supported exchanges with exchanges' - data (ID, name, country, ...) that have active trading volumes on CoinGecko** + To query all the supported exchanges with exchanges' data (ID, name, country, + etc.) that have active trading volumes on CoinGecko Args: - page: page through results, default: 1 + page: Page through results. Default: 1 - per_page: total results per page, default: 100 Valid values: 1...250 + per_page: Total results per page. Default: 100. Valid values: 1...250 extra_headers: Send extra headers @@ -129,13 +129,12 @@ def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetIDResponse: """ - This endpoint allows you to **query exchange's data (name, year established, - country, ...), exchange volume in BTC and top 100 tickers based on exchange's - ID** + To query exchange's data (name, year established, country, etc.), exchange + volume in BTC and top 100 tickers based on exchange's ID Args: dex_pair_format: - set to `symbol` to display DEX pair base and target as symbols, default: + Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` extra_headers: Send extra headers @@ -172,10 +171,10 @@ def get_list( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetListResponse: """ - This endpoint allows you to **query all the exchanges with ID and name** + To query all the exchanges with ID and name Args: - status: filter by status of exchanges, default: active + status: Filter by status of exchanges. Default: `active` extra_headers: Send extra headers @@ -239,13 +238,13 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetResponse: """ - This endpoint allows you to **query all the supported exchanges with exchanges' - data (ID, name, country, ...) that have active trading volumes on CoinGecko** + To query all the supported exchanges with exchanges' data (ID, name, country, + etc.) that have active trading volumes on CoinGecko Args: - page: page through results, default: 1 + page: Page through results. Default: 1 - per_page: total results per page, default: 100 Valid values: 1...250 + per_page: Total results per page. Default: 100. Valid values: 1...250 extra_headers: Send extra headers @@ -286,13 +285,12 @@ async def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetIDResponse: """ - This endpoint allows you to **query exchange's data (name, year established, - country, ...), exchange volume in BTC and top 100 tickers based on exchange's - ID** + To query exchange's data (name, year established, country, etc.), exchange + volume in BTC and top 100 tickers based on exchange's ID Args: dex_pair_format: - set to `symbol` to display DEX pair base and target as symbols, default: + Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` extra_headers: Send extra headers @@ -331,10 +329,10 @@ async def get_list( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ExchangeGetListResponse: """ - This endpoint allows you to **query all the exchanges with ID and name** + To query all the exchanges with ID and name Args: - status: filter by status of exchanges, default: active + status: Filter by status of exchanges. Default: `active` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/exchanges/tickers.py b/src/coingecko_sdk/resources/exchanges/tickers.py index 13d8063..a1017cd 100644 --- a/src/coingecko_sdk/resources/exchanges/tickers.py +++ b/src/coingecko_sdk/resources/exchanges/tickers.py @@ -70,24 +70,24 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TickerGetResponse: """ - This endpoint allows you to **query exchange's tickers based on exchange's ID** + To query exchange's tickers based on exchange's ID Args: - coin_ids: filter tickers by coin IDs, comma-separated if querying more than 1 coin + coin_ids: Filter tickers by coin IDs, comma-separated if querying more than 1 coin. \\**refers to [`/coins/list`](/reference/coins-list). - depth: include 2% orderbook depth (Example: cost_to_move_up_usd & - cost_to_move_down_usd),default: false + depth: Include 2% orderbook depth (cost_to_move_up_usd and cost_to_move_down_usd). + Default: false dex_pair_format: - set to `symbol` to display DEX pair base and target as symbols, default: + Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` - include_exchange_logo: include exchange logo, default: false + include_exchange_logo: Include exchange logo. Default: false - order: use this to sort the order of responses, default: trust_score_desc + order: Sort the order of responses. Default: `trust_score_desc` - page: page through results + page: Page through results. extra_headers: Send extra headers @@ -169,24 +169,24 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TickerGetResponse: """ - This endpoint allows you to **query exchange's tickers based on exchange's ID** + To query exchange's tickers based on exchange's ID Args: - coin_ids: filter tickers by coin IDs, comma-separated if querying more than 1 coin + coin_ids: Filter tickers by coin IDs, comma-separated if querying more than 1 coin. \\**refers to [`/coins/list`](/reference/coins-list). - depth: include 2% orderbook depth (Example: cost_to_move_up_usd & - cost_to_move_down_usd),default: false + depth: Include 2% orderbook depth (cost_to_move_up_usd and cost_to_move_down_usd). + Default: false dex_pair_format: - set to `symbol` to display DEX pair base and target as symbols, default: + Set to `symbol` to display DEX pair base and target as symbols. Default: `contract_address` - include_exchange_logo: include exchange logo, default: false + include_exchange_logo: Include exchange logo. Default: false - order: use this to sort the order of responses, default: trust_score_desc + order: Sort the order of responses. Default: `trust_score_desc` - page: page through results + page: Page through results. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/exchanges/volume_chart.py b/src/coingecko_sdk/resources/exchanges/volume_chart.py index abf1987..ac2545e 100644 --- a/src/coingecko_sdk/resources/exchanges/volume_chart.py +++ b/src/coingecko_sdk/resources/exchanges/volume_chart.py @@ -57,11 +57,11 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> VolumeChartGetResponse: """ - This endpoint allows you to **query the historical volume chart data with time - in UNIX and trading volume data in BTC based on exchange's ID** + To query the historical volume chart data with time in UNIX and trading volume + data in BTC based on exchange's ID Args: - days: data up to number of days ago + days: Data up to number of days ago. extra_headers: Send extra headers @@ -99,13 +99,13 @@ def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> VolumeChartGetRangeResponse: """ - This endpoint allows you to **query the historical volume chart data in BTC by - specifying date range in UNIX based on exchange's ID** + To query the historical volume chart data in BTC by specifying date range in + UNIX based on exchange's ID Args: - from_: starting date in UNIX timestamp + from_: Starting date in UNIX timestamp. - to: ending date in UNIX timestamp + to: Ending date in UNIX timestamp. extra_headers: Send extra headers @@ -169,11 +169,11 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> VolumeChartGetResponse: """ - This endpoint allows you to **query the historical volume chart data with time - in UNIX and trading volume data in BTC based on exchange's ID** + To query the historical volume chart data with time in UNIX and trading volume + data in BTC based on exchange's ID Args: - days: data up to number of days ago + days: Data up to number of days ago. extra_headers: Send extra headers @@ -211,13 +211,13 @@ async def get_range( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> VolumeChartGetRangeResponse: """ - This endpoint allows you to **query the historical volume chart data in BTC by - specifying date range in UNIX based on exchange's ID** + To query the historical volume chart data in BTC by specifying date range in + UNIX based on exchange's ID Args: - from_: starting date in UNIX timestamp + from_: Starting date in UNIX timestamp. - to: ending date in UNIX timestamp + to: Ending date in UNIX timestamp. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/global_/decentralized_finance_defi.py b/src/coingecko_sdk/resources/global_/decentralized_finance_defi.py index 1498c9f..1b8162c 100644 --- a/src/coingecko_sdk/resources/global_/decentralized_finance_defi.py +++ b/src/coingecko_sdk/resources/global_/decentralized_finance_defi.py @@ -50,8 +50,8 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> DecentralizedFinanceDefiGetResponse: """ - This endpoint allows you **query top 100 cryptocurrency global decentralized - finance (DeFi) data including DeFi market cap, trading volume** + To query top 100 cryptocurrency global decentralized finance (DeFi) data + including DeFi market cap, trading volume """ return self._get( "/global/decentralized_finance_defi", @@ -93,8 +93,8 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> DecentralizedFinanceDefiGetResponse: """ - This endpoint allows you **query top 100 cryptocurrency global decentralized - finance (DeFi) data including DeFi market cap, trading volume** + To query top 100 cryptocurrency global decentralized finance (DeFi) data + including DeFi market cap, trading volume """ return await self._get( "/global/decentralized_finance_defi", diff --git a/src/coingecko_sdk/resources/global_/global_.py b/src/coingecko_sdk/resources/global_/global_.py index cc55fbc..95b2f81 100644 --- a/src/coingecko_sdk/resources/global_/global_.py +++ b/src/coingecko_sdk/resources/global_/global_.py @@ -74,8 +74,8 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> GlobalGetResponse: """ - This endpoint allows you **query cryptocurrency global data including active - cryptocurrencies, markets, total crypto market cap and etc** + To query cryptocurrency global data including active cryptocurrencies, markets, + total crypto market cap and etc """ return self._get( "/global", @@ -125,8 +125,8 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> GlobalGetResponse: """ - This endpoint allows you **query cryptocurrency global data including active - cryptocurrencies, markets, total crypto market cap and etc** + To query cryptocurrency global data including active cryptocurrencies, markets, + total crypto market cap and etc """ return await self._get( "/global", diff --git a/src/coingecko_sdk/resources/global_/market_cap_chart.py b/src/coingecko_sdk/resources/global_/market_cap_chart.py index 7f97d49..32d0da7 100644 --- a/src/coingecko_sdk/resources/global_/market_cap_chart.py +++ b/src/coingecko_sdk/resources/global_/market_cap_chart.py @@ -56,14 +56,14 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketCapChartGetResponse: """ - This endpoint allows you to **query historical global market cap and volume data - by number of days away from now** + To query historical global market cap and volume data by number of days away + from now Args: - days: data up to number of days ago Valid values: any integer + days: Data up to number of days ago. - vs_currency: target currency of market cap, default: usd \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) + vs_currency: Target currency of market cap. Default: `usd` \\**refers to + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). extra_headers: Send extra headers @@ -125,14 +125,14 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketCapChartGetResponse: """ - This endpoint allows you to **query historical global market cap and volume data - by number of days away from now** + To query historical global market cap and volume data by number of days away + from now Args: - days: data up to number of days ago Valid values: any integer + days: Data up to number of days ago. - vs_currency: target currency of market cap, default: usd \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) + vs_currency: Target currency of market cap. Default: `usd` \\**refers to + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/key.py b/src/coingecko_sdk/resources/key.py index 7f19724..afd9ed2 100644 --- a/src/coingecko_sdk/resources/key.py +++ b/src/coingecko_sdk/resources/key.py @@ -50,8 +50,8 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> KeyGetResponse: """ - This endpoint allows you to **monitor your account's API usage, including rate - limits, monthly total credits, remaining credits, and more** + To monitor your account's API usage, including rate limits, monthly total + credits, remaining credits, and more """ return self._get( "/key", @@ -93,8 +93,8 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> KeyGetResponse: """ - This endpoint allows you to **monitor your account's API usage, including rate - limits, monthly total credits, remaining credits, and more** + To monitor your account's API usage, including rate limits, monthly total + credits, remaining credits, and more """ return await self._get( "/key", diff --git a/src/coingecko_sdk/resources/news.py b/src/coingecko_sdk/resources/news.py index 9b8e2e9..6bb2979 100644 --- a/src/coingecko_sdk/resources/news.py +++ b/src/coingecko_sdk/resources/news.py @@ -95,20 +95,19 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NewsGetResponse: """ - This endpoint allows you to **query the latest crypto news and guides on - CoinGecko** + To query the latest crypto news and guides on CoinGecko Args: - coin_id: filter news by coin ID \\**refers to [`/coins/list`](/reference/coins-list). + coin_id: Filter news by coin ID. \\**refers to [`/coins/list`](/reference/coins-list). - language: filter news by language Default value: **en** + language: Filter news by language. Default: `en` - page: page through results Default value: **1** + page: Page through results. Default value: 1 Valid values: 1...20 - per_page: total results per page Default value: **10** + per_page: Total results per page. Default value: 10 Valid values: 1...20 - type: filter news by type Default value: **all** Note: `guides` filter is only - applicable if `coin_id` is specified and valid + type: Filter news by type. Default: `all` Note: `guides` filter is only applicable if + `coin_id` is specified and valid. extra_headers: Send extra headers @@ -212,20 +211,19 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NewsGetResponse: """ - This endpoint allows you to **query the latest crypto news and guides on - CoinGecko** + To query the latest crypto news and guides on CoinGecko Args: - coin_id: filter news by coin ID \\**refers to [`/coins/list`](/reference/coins-list). + coin_id: Filter news by coin ID. \\**refers to [`/coins/list`](/reference/coins-list). - language: filter news by language Default value: **en** + language: Filter news by language. Default: `en` - page: page through results Default value: **1** + page: Page through results. Default value: 1 Valid values: 1...20 - per_page: total results per page Default value: **10** + per_page: Total results per page. Default value: 10 Valid values: 1...20 - type: filter news by type Default value: **all** Note: `guides` filter is only - applicable if `coin_id` is specified and valid + type: Filter news by type. Default: `all` Note: `guides` filter is only applicable if + `coin_id` is specified and valid. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/nfts/contract/contract.py b/src/coingecko_sdk/resources/nfts/contract/contract.py index 2a4e4f9..891c6f2 100644 --- a/src/coingecko_sdk/resources/nfts/contract/contract.py +++ b/src/coingecko_sdk/resources/nfts/contract/contract.py @@ -65,9 +65,8 @@ def get_contract_address( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ContractGetContractAddressResponse: """ - This endpoint allows you to **query all the NFT data (name, floor price, 24hr - volume ...) based on the NFT collection contract address and respective asset - platform** + To query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT + collection contract address and respective asset platform Args: extra_headers: Send extra headers @@ -132,9 +131,8 @@ async def get_contract_address( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> ContractGetContractAddressResponse: """ - This endpoint allows you to **query all the NFT data (name, floor price, 24hr - volume ...) based on the NFT collection contract address and respective asset - platform** + To query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT + collection contract address and respective asset platform Args: extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/nfts/contract/market_chart.py b/src/coingecko_sdk/resources/nfts/contract/market_chart.py index a6bc781..39287f0 100644 --- a/src/coingecko_sdk/resources/nfts/contract/market_chart.py +++ b/src/coingecko_sdk/resources/nfts/contract/market_chart.py @@ -55,12 +55,12 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetResponse: """ - This endpoint allows you **query historical market data of a NFT collection, - including floor price, market cap, and 24hr volume, by number of days away from - now based on the provided contract address** + To query historical market data of a NFT collection, including floor price, + market cap, and 24hr volume, by number of days away from now based on the + provided contract address Args: - days: data up to number of days ago Valid values: any integer or max + days: Data up to number of days ago. Valid values: any integer or `max` extra_headers: Send extra headers @@ -125,12 +125,12 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetResponse: """ - This endpoint allows you **query historical market data of a NFT collection, - including floor price, market cap, and 24hr volume, by number of days away from - now based on the provided contract address** + To query historical market data of a NFT collection, including floor price, + market cap, and 24hr volume, by number of days away from now based on the + provided contract address Args: - days: data up to number of days ago Valid values: any integer or max + days: Data up to number of days ago. Valid values: any integer or `max` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/nfts/market_chart.py b/src/coingecko_sdk/resources/nfts/market_chart.py index 0c4f0d3..a4b1533 100644 --- a/src/coingecko_sdk/resources/nfts/market_chart.py +++ b/src/coingecko_sdk/resources/nfts/market_chart.py @@ -54,12 +54,11 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetResponse: """ - This endpoint allows you **query historical market data of a NFT collection, - including floor price, market cap, and 24hr volume, by number of days away from - now** + To query historical market data of a NFT collection, including floor price, + market cap, and 24hr volume, by number of days away from now Args: - days: data up to number of days Valid values: any integer or max + days: Data up to number of days ago. Valid values: any integer or `max` extra_headers: Send extra headers @@ -117,12 +116,11 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MarketChartGetResponse: """ - This endpoint allows you **query historical market data of a NFT collection, - including floor price, market cap, and 24hr volume, by number of days away from - now** + To query historical market data of a NFT collection, including floor price, + market cap, and 24hr volume, by number of days away from now Args: - days: data up to number of days Valid values: any integer or max + days: Data up to number of days ago. Valid values: any integer or `max` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/nfts/nfts.py b/src/coingecko_sdk/resources/nfts/nfts.py index bab86af..57c074c 100644 --- a/src/coingecko_sdk/resources/nfts/nfts.py +++ b/src/coingecko_sdk/resources/nfts/nfts.py @@ -93,8 +93,8 @@ def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NFTGetIDResponse: """ - This endpoint allows you to **query all the NFT data (name, floor price, 24hr - volume ...) based on the NFT collection ID** + To query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT + collection ID Args: extra_headers: Send extra headers @@ -131,8 +131,8 @@ def get_list( "market_cap_usd_desc", ] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -141,15 +141,15 @@ def get_list( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NFTGetListResponse: """ - This endpoint allows you to **query all supported NFTs with ID, contract - address, name, asset platform ID and symbol on CoinGecko** + To query all supported NFTs with ID, contract address, name, asset platform ID + and symbol on CoinGecko Args: - order: use this to sort the order of responses + order: Sort order of responses. - page: page through results + page: Page through results. - per_page: total results per page Valid values: 1...250 + per_page: Total results per page. Valid values: 1...250 extra_headers: Send extra headers @@ -191,8 +191,8 @@ def get_markets( "market_cap_usd_desc", ] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -201,20 +201,18 @@ def get_markets( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NFTGetMarketsResponse: """ - This endpoint allows you to **query all the supported NFT collections with floor - price, market cap, volume and market related data on CoinGecko** + To query all the supported NFT collections with floor price, market cap, volume + and market related data on CoinGecko Args: - asset_platform_id: filter result by asset platform (blockchain network) \\**refers to - [`/asset_platforms`](/reference/asset-platforms-list) filter=`nft` + asset_platform_id: Filter result by asset platform (blockchain network). \\**refers to + [`/asset_platforms`](/reference/asset-platforms-list) filter=`nft`. - order: sort results by field Default: `market_cap_usd_desc` + order: Sort results by field. Default: `market_cap_usd_desc` - page: page through results Default: `1` + page: Page through results. Default value: 1 - per_page: - total results per page Valid values: any integer between 1 and 250 Default: - `100` + per_page: Total results per page. Default value: 100 Valid values: 1...250 extra_headers: Send extra headers @@ -289,8 +287,8 @@ async def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NFTGetIDResponse: """ - This endpoint allows you to **query all the NFT data (name, floor price, 24hr - volume ...) based on the NFT collection ID** + To query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT + collection ID Args: extra_headers: Send extra headers @@ -327,8 +325,8 @@ async def get_list( "market_cap_usd_desc", ] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -337,15 +335,15 @@ async def get_list( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NFTGetListResponse: """ - This endpoint allows you to **query all supported NFTs with ID, contract - address, name, asset platform ID and symbol on CoinGecko** + To query all supported NFTs with ID, contract address, name, asset platform ID + and symbol on CoinGecko Args: - order: use this to sort the order of responses + order: Sort order of responses. - page: page through results + page: Page through results. - per_page: total results per page Valid values: 1...250 + per_page: Total results per page. Valid values: 1...250 extra_headers: Send extra headers @@ -387,8 +385,8 @@ async def get_markets( "market_cap_usd_desc", ] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -397,20 +395,18 @@ async def get_markets( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NFTGetMarketsResponse: """ - This endpoint allows you to **query all the supported NFT collections with floor - price, market cap, volume and market related data on CoinGecko** + To query all the supported NFT collections with floor price, market cap, volume + and market related data on CoinGecko Args: - asset_platform_id: filter result by asset platform (blockchain network) \\**refers to - [`/asset_platforms`](/reference/asset-platforms-list) filter=`nft` + asset_platform_id: Filter result by asset platform (blockchain network). \\**refers to + [`/asset_platforms`](/reference/asset-platforms-list) filter=`nft`. - order: sort results by field Default: `market_cap_usd_desc` + order: Sort results by field. Default: `market_cap_usd_desc` - page: page through results Default: `1` + page: Page through results. Default value: 1 - per_page: - total results per page Valid values: any integer between 1 and 250 Default: - `100` + per_page: Total results per page. Default value: 100 Valid values: 1...250 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/nfts/tickers.py b/src/coingecko_sdk/resources/nfts/tickers.py index 4728ebe..9d51f24 100644 --- a/src/coingecko_sdk/resources/nfts/tickers.py +++ b/src/coingecko_sdk/resources/nfts/tickers.py @@ -52,8 +52,8 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TickerGetResponse: """ - This endpoint allows you to **query the latest floor price and 24hr volume of a - NFT collection, on each NFT marketplace, e.g. OpenSea and LooksRare** + To query the latest floor price and 24hr volume of a NFT collection, on each NFT + marketplace, e.g. OpenSea and Blur Args: extra_headers: Send extra headers @@ -107,8 +107,8 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TickerGetResponse: """ - This endpoint allows you to **query the latest floor price and 24hr volume of a - NFT collection, on each NFT marketplace, e.g. OpenSea and LooksRare** + To query the latest floor price and 24hr volume of a NFT collection, on each NFT + marketplace, e.g. OpenSea and Blur Args: extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/categories.py b/src/coingecko_sdk/resources/onchain/categories.py index 80964e2..e53360a 100644 --- a/src/coingecko_sdk/resources/onchain/categories.py +++ b/src/coingecko_sdk/resources/onchain/categories.py @@ -66,13 +66,12 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CategoryGetResponse: """ - This endpoint allows you to **query all the supported categories on - GeckoTerminal** + To query all the supported categories on GeckoTerminal Args: - page: page through results Default value: `1` + page: Page through results. Default value: 1 - sort: sort the categories by field Default value: `h6_volume_percentage_desc` + sort: Sort the categories by field. Default: `h6_volume_percentage_desc` extra_headers: Send extra headers @@ -125,17 +124,16 @@ def get_pools( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CategoryGetPoolsResponse: """ - This endpoint allows you to **query all the pools based on the provided category - ID** + To query all the pools based on the provided category ID Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network`. Example: `base_token` or - `base_token,dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - page: page through results Default value: `1` + page: Page through results. Default value: 1 - sort: sort the pools by field Default value: `pool_created_at_desc` + sort: Sort the pools by field. Default: `pool_created_at_desc` extra_headers: Send extra headers @@ -209,13 +207,12 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CategoryGetResponse: """ - This endpoint allows you to **query all the supported categories on - GeckoTerminal** + To query all the supported categories on GeckoTerminal Args: - page: page through results Default value: `1` + page: Page through results. Default value: 1 - sort: sort the categories by field Default value: `h6_volume_percentage_desc` + sort: Sort the categories by field. Default: `h6_volume_percentage_desc` extra_headers: Send extra headers @@ -268,17 +265,16 @@ async def get_pools( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> CategoryGetPoolsResponse: """ - This endpoint allows you to **query all the pools based on the provided category - ID** + To query all the pools based on the provided category ID Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network`. Example: `base_token` or - `base_token,dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - page: page through results Default value: `1` + page: Page through results. Default value: 1 - sort: sort the pools by field Default value: `pool_created_at_desc` + sort: Sort the pools by field. Default: `pool_created_at_desc` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/__init__.py b/src/coingecko_sdk/resources/onchain/networks/__init__.py index cf7b8e5..65fa51d 100644 --- a/src/coingecko_sdk/resources/onchain/networks/__init__.py +++ b/src/coingecko_sdk/resources/onchain/networks/__init__.py @@ -50,24 +50,18 @@ ) __all__ = [ - "NewPoolsResource", - "AsyncNewPoolsResource", - "NewPoolsResourceWithRawResponse", - "AsyncNewPoolsResourceWithRawResponse", - "NewPoolsResourceWithStreamingResponse", - "AsyncNewPoolsResourceWithStreamingResponse", - "TrendingPoolsResource", - "AsyncTrendingPoolsResource", - "TrendingPoolsResourceWithRawResponse", - "AsyncTrendingPoolsResourceWithRawResponse", - "TrendingPoolsResourceWithStreamingResponse", - "AsyncTrendingPoolsResourceWithStreamingResponse", "DexesResource", "AsyncDexesResource", "DexesResourceWithRawResponse", "AsyncDexesResourceWithRawResponse", "DexesResourceWithStreamingResponse", "AsyncDexesResourceWithStreamingResponse", + "NewPoolsResource", + "AsyncNewPoolsResource", + "NewPoolsResourceWithRawResponse", + "AsyncNewPoolsResourceWithRawResponse", + "NewPoolsResourceWithStreamingResponse", + "AsyncNewPoolsResourceWithStreamingResponse", "PoolsResource", "AsyncPoolsResource", "PoolsResourceWithRawResponse", @@ -80,6 +74,12 @@ "AsyncTokensResourceWithRawResponse", "TokensResourceWithStreamingResponse", "AsyncTokensResourceWithStreamingResponse", + "TrendingPoolsResource", + "AsyncTrendingPoolsResource", + "TrendingPoolsResourceWithRawResponse", + "AsyncTrendingPoolsResourceWithRawResponse", + "TrendingPoolsResourceWithStreamingResponse", + "AsyncTrendingPoolsResourceWithStreamingResponse", "NetworksResource", "AsyncNetworksResource", "NetworksResourceWithRawResponse", diff --git a/src/coingecko_sdk/resources/onchain/networks/dexes.py b/src/coingecko_sdk/resources/onchain/networks/dexes.py index 21b55cf..fa446f0 100644 --- a/src/coingecko_sdk/resources/onchain/networks/dexes.py +++ b/src/coingecko_sdk/resources/onchain/networks/dexes.py @@ -57,11 +57,11 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> DexGetResponse: """ - This endpoint allows you to **query all the supported decentralized exchanges - (DEXs) based on the provided network on GeckoTerminal** + To query all the supported decentralized exchanges (DEXs) based on the provided + network on GeckoTerminal Args: - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -102,19 +102,20 @@ def get_pools( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> DexGetPoolsResponse: """ - This endpoint allows you to **query all the top pools based on the provided - network and decentralized exchange (DEX)** + To query all the top pools based on the provided network and decentralized + exchange (DEX) Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 - sort: sort the pools by field Default value: h24_tx_count_desc + sort: Sort the pools by field. Default: `h24_tx_count_desc` extra_headers: Send extra headers @@ -182,11 +183,11 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> DexGetResponse: """ - This endpoint allows you to **query all the supported decentralized exchanges - (DEXs) based on the provided network on GeckoTerminal** + To query all the supported decentralized exchanges (DEXs) based on the provided + network on GeckoTerminal Args: - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -227,19 +228,20 @@ async def get_pools( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> DexGetPoolsResponse: """ - This endpoint allows you to **query all the top pools based on the provided - network and decentralized exchange (DEX)** + To query all the top pools based on the provided network and decentralized + exchange (DEX) Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 - sort: sort the pools by field Default value: h24_tx_count_desc + sort: Sort the pools by field. Default: `h24_tx_count_desc` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/networks.py b/src/coingecko_sdk/resources/onchain/networks/networks.py index 574dc92..4303809 100644 --- a/src/coingecko_sdk/resources/onchain/networks/networks.py +++ b/src/coingecko_sdk/resources/onchain/networks/networks.py @@ -62,18 +62,14 @@ class NetworksResource(SyncAPIResource): - @cached_property - def new_pools(self) -> NewPoolsResource: - return NewPoolsResource(self._client) - - @cached_property - def trending_pools(self) -> TrendingPoolsResource: - return TrendingPoolsResource(self._client) - @cached_property def dexes(self) -> DexesResource: return DexesResource(self._client) + @cached_property + def new_pools(self) -> NewPoolsResource: + return NewPoolsResource(self._client) + @cached_property def pools(self) -> PoolsResource: return PoolsResource(self._client) @@ -82,6 +78,10 @@ def pools(self) -> PoolsResource: def tokens(self) -> TokensResource: return TokensResource(self._client) + @cached_property + def trending_pools(self) -> TrendingPoolsResource: + return TrendingPoolsResource(self._client) + @cached_property def with_raw_response(self) -> NetworksResourceWithRawResponse: """ @@ -113,11 +113,10 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NetworkGetResponse: """ - This endpoint allows you to **query all the supported networks on - GeckoTerminal** + To retrieve a list of all supported networks on GeckoTerminal Args: - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -141,18 +140,14 @@ def get( class AsyncNetworksResource(AsyncAPIResource): - @cached_property - def new_pools(self) -> AsyncNewPoolsResource: - return AsyncNewPoolsResource(self._client) - - @cached_property - def trending_pools(self) -> AsyncTrendingPoolsResource: - return AsyncTrendingPoolsResource(self._client) - @cached_property def dexes(self) -> AsyncDexesResource: return AsyncDexesResource(self._client) + @cached_property + def new_pools(self) -> AsyncNewPoolsResource: + return AsyncNewPoolsResource(self._client) + @cached_property def pools(self) -> AsyncPoolsResource: return AsyncPoolsResource(self._client) @@ -161,6 +156,10 @@ def pools(self) -> AsyncPoolsResource: def tokens(self) -> AsyncTokensResource: return AsyncTokensResource(self._client) + @cached_property + def trending_pools(self) -> AsyncTrendingPoolsResource: + return AsyncTrendingPoolsResource(self._client) + @cached_property def with_raw_response(self) -> AsyncNetworksResourceWithRawResponse: """ @@ -192,11 +191,10 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NetworkGetResponse: """ - This endpoint allows you to **query all the supported networks on - GeckoTerminal** + To retrieve a list of all supported networks on GeckoTerminal Args: - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -227,18 +225,14 @@ def __init__(self, networks: NetworksResource) -> None: networks.get, ) - @cached_property - def new_pools(self) -> NewPoolsResourceWithRawResponse: - return NewPoolsResourceWithRawResponse(self._networks.new_pools) - - @cached_property - def trending_pools(self) -> TrendingPoolsResourceWithRawResponse: - return TrendingPoolsResourceWithRawResponse(self._networks.trending_pools) - @cached_property def dexes(self) -> DexesResourceWithRawResponse: return DexesResourceWithRawResponse(self._networks.dexes) + @cached_property + def new_pools(self) -> NewPoolsResourceWithRawResponse: + return NewPoolsResourceWithRawResponse(self._networks.new_pools) + @cached_property def pools(self) -> PoolsResourceWithRawResponse: return PoolsResourceWithRawResponse(self._networks.pools) @@ -247,6 +241,10 @@ def pools(self) -> PoolsResourceWithRawResponse: def tokens(self) -> TokensResourceWithRawResponse: return TokensResourceWithRawResponse(self._networks.tokens) + @cached_property + def trending_pools(self) -> TrendingPoolsResourceWithRawResponse: + return TrendingPoolsResourceWithRawResponse(self._networks.trending_pools) + class AsyncNetworksResourceWithRawResponse: def __init__(self, networks: AsyncNetworksResource) -> None: @@ -256,18 +254,14 @@ def __init__(self, networks: AsyncNetworksResource) -> None: networks.get, ) - @cached_property - def new_pools(self) -> AsyncNewPoolsResourceWithRawResponse: - return AsyncNewPoolsResourceWithRawResponse(self._networks.new_pools) - - @cached_property - def trending_pools(self) -> AsyncTrendingPoolsResourceWithRawResponse: - return AsyncTrendingPoolsResourceWithRawResponse(self._networks.trending_pools) - @cached_property def dexes(self) -> AsyncDexesResourceWithRawResponse: return AsyncDexesResourceWithRawResponse(self._networks.dexes) + @cached_property + def new_pools(self) -> AsyncNewPoolsResourceWithRawResponse: + return AsyncNewPoolsResourceWithRawResponse(self._networks.new_pools) + @cached_property def pools(self) -> AsyncPoolsResourceWithRawResponse: return AsyncPoolsResourceWithRawResponse(self._networks.pools) @@ -276,6 +270,10 @@ def pools(self) -> AsyncPoolsResourceWithRawResponse: def tokens(self) -> AsyncTokensResourceWithRawResponse: return AsyncTokensResourceWithRawResponse(self._networks.tokens) + @cached_property + def trending_pools(self) -> AsyncTrendingPoolsResourceWithRawResponse: + return AsyncTrendingPoolsResourceWithRawResponse(self._networks.trending_pools) + class NetworksResourceWithStreamingResponse: def __init__(self, networks: NetworksResource) -> None: @@ -285,18 +283,14 @@ def __init__(self, networks: NetworksResource) -> None: networks.get, ) - @cached_property - def new_pools(self) -> NewPoolsResourceWithStreamingResponse: - return NewPoolsResourceWithStreamingResponse(self._networks.new_pools) - - @cached_property - def trending_pools(self) -> TrendingPoolsResourceWithStreamingResponse: - return TrendingPoolsResourceWithStreamingResponse(self._networks.trending_pools) - @cached_property def dexes(self) -> DexesResourceWithStreamingResponse: return DexesResourceWithStreamingResponse(self._networks.dexes) + @cached_property + def new_pools(self) -> NewPoolsResourceWithStreamingResponse: + return NewPoolsResourceWithStreamingResponse(self._networks.new_pools) + @cached_property def pools(self) -> PoolsResourceWithStreamingResponse: return PoolsResourceWithStreamingResponse(self._networks.pools) @@ -305,6 +299,10 @@ def pools(self) -> PoolsResourceWithStreamingResponse: def tokens(self) -> TokensResourceWithStreamingResponse: return TokensResourceWithStreamingResponse(self._networks.tokens) + @cached_property + def trending_pools(self) -> TrendingPoolsResourceWithStreamingResponse: + return TrendingPoolsResourceWithStreamingResponse(self._networks.trending_pools) + class AsyncNetworksResourceWithStreamingResponse: def __init__(self, networks: AsyncNetworksResource) -> None: @@ -314,18 +312,14 @@ def __init__(self, networks: AsyncNetworksResource) -> None: networks.get, ) - @cached_property - def new_pools(self) -> AsyncNewPoolsResourceWithStreamingResponse: - return AsyncNewPoolsResourceWithStreamingResponse(self._networks.new_pools) - - @cached_property - def trending_pools(self) -> AsyncTrendingPoolsResourceWithStreamingResponse: - return AsyncTrendingPoolsResourceWithStreamingResponse(self._networks.trending_pools) - @cached_property def dexes(self) -> AsyncDexesResourceWithStreamingResponse: return AsyncDexesResourceWithStreamingResponse(self._networks.dexes) + @cached_property + def new_pools(self) -> AsyncNewPoolsResourceWithStreamingResponse: + return AsyncNewPoolsResourceWithStreamingResponse(self._networks.new_pools) + @cached_property def pools(self) -> AsyncPoolsResourceWithStreamingResponse: return AsyncPoolsResourceWithStreamingResponse(self._networks.pools) @@ -333,3 +327,7 @@ def pools(self) -> AsyncPoolsResourceWithStreamingResponse: @cached_property def tokens(self) -> AsyncTokensResourceWithStreamingResponse: return AsyncTokensResourceWithStreamingResponse(self._networks.tokens) + + @cached_property + def trending_pools(self) -> AsyncTrendingPoolsResourceWithStreamingResponse: + return AsyncTrendingPoolsResourceWithStreamingResponse(self._networks.trending_pools) diff --git a/src/coingecko_sdk/resources/onchain/networks/new_pools.py b/src/coingecko_sdk/resources/onchain/networks/new_pools.py index 2746bb7..7206b2e 100644 --- a/src/coingecko_sdk/resources/onchain/networks/new_pools.py +++ b/src/coingecko_sdk/resources/onchain/networks/new_pools.py @@ -56,17 +56,17 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NewPoolGetResponse: """ - This endpoint allows you to **query all the latest pools across all networks on - GeckoTerminal** + To query all the latest pools across all networks on GeckoTerminal Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -110,17 +110,17 @@ def get_network( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NewPoolGetNetworkResponse: """ - This endpoint allows you to **query all the latest pools based on provided - network** + To query all the latest pools based on the provided network Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -186,17 +186,17 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NewPoolGetResponse: """ - This endpoint allows you to **query all the latest pools across all networks on - GeckoTerminal** + To query all the latest pools across all networks on GeckoTerminal Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -240,17 +240,17 @@ async def get_network( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> NewPoolGetNetworkResponse: """ - This endpoint allows you to **query all the latest pools based on provided - network** + To query all the latest pools based on the provided network Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/pools/__init__.py b/src/coingecko_sdk/resources/onchain/networks/pools/__init__.py index b77c27a..a29aad3 100644 --- a/src/coingecko_sdk/resources/onchain/networks/pools/__init__.py +++ b/src/coingecko_sdk/resources/onchain/networks/pools/__init__.py @@ -42,18 +42,18 @@ ) __all__ = [ - "MultiResource", - "AsyncMultiResource", - "MultiResourceWithRawResponse", - "AsyncMultiResourceWithRawResponse", - "MultiResourceWithStreamingResponse", - "AsyncMultiResourceWithStreamingResponse", "InfoResource", "AsyncInfoResource", "InfoResourceWithRawResponse", "AsyncInfoResourceWithRawResponse", "InfoResourceWithStreamingResponse", "AsyncInfoResourceWithStreamingResponse", + "MultiResource", + "AsyncMultiResource", + "MultiResourceWithRawResponse", + "AsyncMultiResourceWithRawResponse", + "MultiResourceWithStreamingResponse", + "AsyncMultiResourceWithStreamingResponse", "OhlcvResource", "AsyncOhlcvResource", "OhlcvResourceWithRawResponse", diff --git a/src/coingecko_sdk/resources/onchain/networks/pools/info.py b/src/coingecko_sdk/resources/onchain/networks/pools/info.py index 8f2d0af..dc3ad80 100644 --- a/src/coingecko_sdk/resources/onchain/networks/pools/info.py +++ b/src/coingecko_sdk/resources/onchain/networks/pools/info.py @@ -57,12 +57,12 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> InfoGetResponse: """ - This endpoint allows you to **query pool metadata (base and quote token details, - image, socials, websites, description, contract address, etc.) based on a - provided pool contract address on a network** + To query pool metadata (base and quote token details, image, socials, websites, + description, contract address, etc.) based on a provided pool contract address + on a network Args: - include: attributes to include + include: Attributes to include. extra_headers: Send extra headers @@ -125,12 +125,12 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> InfoGetResponse: """ - This endpoint allows you to **query pool metadata (base and quote token details, - image, socials, websites, description, contract address, etc.) based on a - provided pool contract address on a network** + To query pool metadata (base and quote token details, image, socials, websites, + description, contract address, etc.) based on a provided pool contract address + on a network Args: - include: attributes to include + include: Attributes to include. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/pools/multi.py b/src/coingecko_sdk/resources/onchain/networks/pools/multi.py index 18d637b..65f6fae 100644 --- a/src/coingecko_sdk/resources/onchain/networks/pools/multi.py +++ b/src/coingecko_sdk/resources/onchain/networks/pools/multi.py @@ -57,16 +57,16 @@ def get_addresses( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MultiGetAddressesResponse: """ - This endpoint allows you to **query multiple pools based on the provided network - and pool address** + To query multiple pools based on the provided network and pool addresses Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_composition: include pool composition, default: false + include_composition: Include pool composition. Default: `false` - include_volume_breakdown: include volume breakdown, default: false + include_volume_breakdown: Include volume breakdown. Default: `false` extra_headers: Send extra headers @@ -136,16 +136,16 @@ async def get_addresses( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MultiGetAddressesResponse: """ - This endpoint allows you to **query multiple pools based on the provided network - and pool address** + To query multiple pools based on the provided network and pool addresses Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_composition: include pool composition, default: false + include_composition: Include pool composition. Default: `false` - include_volume_breakdown: include volume breakdown, default: false + include_volume_breakdown: Include volume breakdown. Default: `false` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/pools/ohlcv.py b/src/coingecko_sdk/resources/onchain/networks/pools/ohlcv.py index 57132bb..5cb7871 100644 --- a/src/coingecko_sdk/resources/onchain/networks/pools/ohlcv.py +++ b/src/coingecko_sdk/resources/onchain/networks/pools/ohlcv.py @@ -63,24 +63,24 @@ def get_timeframe( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> OhlcvGetTimeframeResponse: """ - This endpoint allows you to **get the OHLCV chart (Open, High, Low, Close, - Volume) of a pool based on the provided pool address on a network** + To get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the + provided pool address on a network Args: - token: return OHLCV for token use this to invert the chart Available values: 'base', - 'quote' or token address Default value: 'base' + token: Return OHLCV for token, use this to invert the chart. Available values: `base`, + `quote`, or token address. Default: `base` - aggregate: time period to aggregate each OHLCV Available values (day): `1` Available values - (hour): `1` , `4` , `12` Available values (minute): `1` , `5` , `15` Available - values (second): `1`, `15`, `30` Default value: 1 + aggregate: Time period to aggregate each OHLCV. Available values (day): `1` Available + values (hour): `1`, `4`, `12` Available values (minute): `1`, `5`, `15` + Available values (second): `1`, `15`, `30` Default value: 1 - before_timestamp: return OHLCV data before this timestamp (integer seconds since epoch) + before_timestamp: Return OHLCV data before this timestamp (integer seconds since epoch). - currency: return OHLCV in USD or quote token Default value: usd + currency: Return OHLCV in USD or quote token. Default: `usd` - include_empty_intervals: include empty intervals with no trade data, default: false + include_empty_intervals: Include empty intervals with no trade data. Default: `false` - limit: number of OHLCV results to return, maximum 1000 Default value: 100 + limit: Number of OHLCV results to return, maximum 1000. Default value: 100 extra_headers: Send extra headers @@ -164,24 +164,24 @@ async def get_timeframe( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> OhlcvGetTimeframeResponse: """ - This endpoint allows you to **get the OHLCV chart (Open, High, Low, Close, - Volume) of a pool based on the provided pool address on a network** + To get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the + provided pool address on a network Args: - token: return OHLCV for token use this to invert the chart Available values: 'base', - 'quote' or token address Default value: 'base' + token: Return OHLCV for token, use this to invert the chart. Available values: `base`, + `quote`, or token address. Default: `base` - aggregate: time period to aggregate each OHLCV Available values (day): `1` Available values - (hour): `1` , `4` , `12` Available values (minute): `1` , `5` , `15` Available - values (second): `1`, `15`, `30` Default value: 1 + aggregate: Time period to aggregate each OHLCV. Available values (day): `1` Available + values (hour): `1`, `4`, `12` Available values (minute): `1`, `5`, `15` + Available values (second): `1`, `15`, `30` Default value: 1 - before_timestamp: return OHLCV data before this timestamp (integer seconds since epoch) + before_timestamp: Return OHLCV data before this timestamp (integer seconds since epoch). - currency: return OHLCV in USD or quote token Default value: usd + currency: Return OHLCV in USD or quote token. Default: `usd` - include_empty_intervals: include empty intervals with no trade data, default: false + include_empty_intervals: Include empty intervals with no trade data. Default: `false` - limit: number of OHLCV results to return, maximum 1000 Default value: 100 + limit: Number of OHLCV results to return, maximum 1000. Default value: 100 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/pools/pools.py b/src/coingecko_sdk/resources/onchain/networks/pools/pools.py index af9c4e3..6d0a02c 100644 --- a/src/coingecko_sdk/resources/onchain/networks/pools/pools.py +++ b/src/coingecko_sdk/resources/onchain/networks/pools/pools.py @@ -57,14 +57,14 @@ class PoolsResource(SyncAPIResource): - @cached_property - def multi(self) -> MultiResource: - return MultiResource(self._client) - @cached_property def info(self) -> InfoResource: return InfoResource(self._client) + @cached_property + def multi(self) -> MultiResource: + return MultiResource(self._client) + @cached_property def ohlcv(self) -> OhlcvResource: return OhlcvResource(self._client) @@ -108,19 +108,19 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PoolGetResponse: """ - This endpoint allows you to **query all the top pools based on the provided - network** + To query all the top pools based on the provided network Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 - sort: sort the pools by field Default value: h24_tx_count_desc + sort: Sort the pools by field. Default: `h24_tx_count_desc` extra_headers: Send extra headers @@ -168,16 +168,16 @@ def get_address( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PoolGetAddressResponse: """ - This endpoint allows you to **query the specific pool based on the provided - network and pool address** + To query the specific pool based on the provided network and pool address Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_composition: include pool composition, default: false + include_composition: Include pool composition. Default: `false` - include_volume_breakdown: include volume breakdown, default: false + include_volume_breakdown: Include volume breakdown. Default: `false` extra_headers: Send extra headers @@ -212,14 +212,14 @@ def get_address( class AsyncPoolsResource(AsyncAPIResource): - @cached_property - def multi(self) -> AsyncMultiResource: - return AsyncMultiResource(self._client) - @cached_property def info(self) -> AsyncInfoResource: return AsyncInfoResource(self._client) + @cached_property + def multi(self) -> AsyncMultiResource: + return AsyncMultiResource(self._client) + @cached_property def ohlcv(self) -> AsyncOhlcvResource: return AsyncOhlcvResource(self._client) @@ -263,19 +263,19 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PoolGetResponse: """ - This endpoint allows you to **query all the top pools based on the provided - network** + To query all the top pools based on the provided network Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 - sort: sort the pools by field Default value: h24_tx_count_desc + sort: Sort the pools by field. Default: `h24_tx_count_desc` extra_headers: Send extra headers @@ -323,16 +323,16 @@ async def get_address( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PoolGetAddressResponse: """ - This endpoint allows you to **query the specific pool based on the provided - network and pool address** + To query the specific pool based on the provided network and pool address Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_composition: include pool composition, default: false + include_composition: Include pool composition. Default: `false` - include_volume_breakdown: include volume breakdown, default: false + include_volume_breakdown: Include volume breakdown. Default: `false` extra_headers: Send extra headers @@ -377,14 +377,14 @@ def __init__(self, pools: PoolsResource) -> None: pools.get_address, ) - @cached_property - def multi(self) -> MultiResourceWithRawResponse: - return MultiResourceWithRawResponse(self._pools.multi) - @cached_property def info(self) -> InfoResourceWithRawResponse: return InfoResourceWithRawResponse(self._pools.info) + @cached_property + def multi(self) -> MultiResourceWithRawResponse: + return MultiResourceWithRawResponse(self._pools.multi) + @cached_property def ohlcv(self) -> OhlcvResourceWithRawResponse: return OhlcvResourceWithRawResponse(self._pools.ohlcv) @@ -405,14 +405,14 @@ def __init__(self, pools: AsyncPoolsResource) -> None: pools.get_address, ) - @cached_property - def multi(self) -> AsyncMultiResourceWithRawResponse: - return AsyncMultiResourceWithRawResponse(self._pools.multi) - @cached_property def info(self) -> AsyncInfoResourceWithRawResponse: return AsyncInfoResourceWithRawResponse(self._pools.info) + @cached_property + def multi(self) -> AsyncMultiResourceWithRawResponse: + return AsyncMultiResourceWithRawResponse(self._pools.multi) + @cached_property def ohlcv(self) -> AsyncOhlcvResourceWithRawResponse: return AsyncOhlcvResourceWithRawResponse(self._pools.ohlcv) @@ -433,14 +433,14 @@ def __init__(self, pools: PoolsResource) -> None: pools.get_address, ) - @cached_property - def multi(self) -> MultiResourceWithStreamingResponse: - return MultiResourceWithStreamingResponse(self._pools.multi) - @cached_property def info(self) -> InfoResourceWithStreamingResponse: return InfoResourceWithStreamingResponse(self._pools.info) + @cached_property + def multi(self) -> MultiResourceWithStreamingResponse: + return MultiResourceWithStreamingResponse(self._pools.multi) + @cached_property def ohlcv(self) -> OhlcvResourceWithStreamingResponse: return OhlcvResourceWithStreamingResponse(self._pools.ohlcv) @@ -461,14 +461,14 @@ def __init__(self, pools: AsyncPoolsResource) -> None: pools.get_address, ) - @cached_property - def multi(self) -> AsyncMultiResourceWithStreamingResponse: - return AsyncMultiResourceWithStreamingResponse(self._pools.multi) - @cached_property def info(self) -> AsyncInfoResourceWithStreamingResponse: return AsyncInfoResourceWithStreamingResponse(self._pools.info) + @cached_property + def multi(self) -> AsyncMultiResourceWithStreamingResponse: + return AsyncMultiResourceWithStreamingResponse(self._pools.multi) + @cached_property def ohlcv(self) -> AsyncOhlcvResourceWithStreamingResponse: return AsyncOhlcvResourceWithStreamingResponse(self._pools.ohlcv) diff --git a/src/coingecko_sdk/resources/onchain/networks/pools/trades.py b/src/coingecko_sdk/resources/onchain/networks/pools/trades.py index 9dc1ee5..12e3b97 100644 --- a/src/coingecko_sdk/resources/onchain/networks/pools/trades.py +++ b/src/coingecko_sdk/resources/onchain/networks/pools/trades.py @@ -56,14 +56,14 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TradeGetResponse: """ - This endpoint allows you to **query the last 300 trades in the past 24 hours - based on the provided pool address** + To query the last 300 trades in the past 24 hours based on the provided pool + address Args: - token: return trades for token use this to invert the chart Available values: 'base', - 'quote' or token address Default value: 'base' + token: Return trades for token, use this to invert the chart. Available values: `base`, + `quote`, or token address. Default: `base` - trade_volume_in_usd_greater_than: filter trades by trade volume in USD greater than this value Default value: 0 + trade_volume_in_usd_greater_than: Filter trades by trade volume in USD greater than this value. Default value: 0 extra_headers: Send extra headers @@ -133,14 +133,14 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TradeGetResponse: """ - This endpoint allows you to **query the last 300 trades in the past 24 hours - based on the provided pool address** + To query the last 300 trades in the past 24 hours based on the provided pool + address Args: - token: return trades for token use this to invert the chart Available values: 'base', - 'quote' or token address Default value: 'base' + token: Return trades for token, use this to invert the chart. Available values: `base`, + `quote`, or token address. Default: `base` - trade_volume_in_usd_greater_than: filter trades by trade volume in USD greater than this value Default value: 0 + trade_volume_in_usd_greater_than: Filter trades by trade volume in USD greater than this value. Default value: 0 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/__init__.py b/src/coingecko_sdk/resources/onchain/networks/tokens/__init__.py index 4c1a9b7..3d03385 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/__init__.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/__init__.py @@ -74,30 +74,24 @@ ) __all__ = [ - "MultiResource", - "AsyncMultiResource", - "MultiResourceWithRawResponse", - "AsyncMultiResourceWithRawResponse", - "MultiResourceWithStreamingResponse", - "AsyncMultiResourceWithStreamingResponse", - "InfoResource", - "AsyncInfoResource", - "InfoResourceWithRawResponse", - "AsyncInfoResourceWithRawResponse", - "InfoResourceWithStreamingResponse", - "AsyncInfoResourceWithStreamingResponse", - "TopHoldersResource", - "AsyncTopHoldersResource", - "TopHoldersResourceWithRawResponse", - "AsyncTopHoldersResourceWithRawResponse", - "TopHoldersResourceWithStreamingResponse", - "AsyncTopHoldersResourceWithStreamingResponse", "HoldersChartResource", "AsyncHoldersChartResource", "HoldersChartResourceWithRawResponse", "AsyncHoldersChartResourceWithRawResponse", "HoldersChartResourceWithStreamingResponse", "AsyncHoldersChartResourceWithStreamingResponse", + "InfoResource", + "AsyncInfoResource", + "InfoResourceWithRawResponse", + "AsyncInfoResourceWithRawResponse", + "InfoResourceWithStreamingResponse", + "AsyncInfoResourceWithStreamingResponse", + "MultiResource", + "AsyncMultiResource", + "MultiResourceWithRawResponse", + "AsyncMultiResourceWithRawResponse", + "MultiResourceWithStreamingResponse", + "AsyncMultiResourceWithStreamingResponse", "OhlcvResource", "AsyncOhlcvResource", "OhlcvResourceWithRawResponse", @@ -110,18 +104,24 @@ "AsyncPoolsResourceWithRawResponse", "PoolsResourceWithStreamingResponse", "AsyncPoolsResourceWithStreamingResponse", - "TradesResource", - "AsyncTradesResource", - "TradesResourceWithRawResponse", - "AsyncTradesResourceWithRawResponse", - "TradesResourceWithStreamingResponse", - "AsyncTradesResourceWithStreamingResponse", + "TopHoldersResource", + "AsyncTopHoldersResource", + "TopHoldersResourceWithRawResponse", + "AsyncTopHoldersResourceWithRawResponse", + "TopHoldersResourceWithStreamingResponse", + "AsyncTopHoldersResourceWithStreamingResponse", "TopTradersResource", "AsyncTopTradersResource", "TopTradersResourceWithRawResponse", "AsyncTopTradersResourceWithRawResponse", "TopTradersResourceWithStreamingResponse", "AsyncTopTradersResourceWithStreamingResponse", + "TradesResource", + "AsyncTradesResource", + "TradesResourceWithRawResponse", + "AsyncTradesResourceWithRawResponse", + "TradesResourceWithStreamingResponse", + "AsyncTradesResourceWithStreamingResponse", "TokensResource", "AsyncTokensResource", "TokensResourceWithRawResponse", diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/holders_chart.py b/src/coingecko_sdk/resources/onchain/networks/tokens/holders_chart.py index a09327e..5b22b34 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/holders_chart.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/holders_chart.py @@ -57,11 +57,11 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> HoldersChartGetResponse: """ - This endpoint allows you to **get the historical token holders chart based on - the provided token contract address on a network** + To get the historical token holders chart based on the provided token contract + address on a network Args: - days: number of days to return the historical token holders chart Default value: 7 + days: Number of days to return the historical token holders chart. Default value: 7 extra_headers: Send extra headers @@ -126,11 +126,11 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> HoldersChartGetResponse: """ - This endpoint allows you to **get the historical token holders chart based on - the provided token contract address on a network** + To get the historical token holders chart based on the provided token contract + address on a network Args: - days: number of days to return the historical token holders chart Default value: 7 + days: Number of days to return the historical token holders chart. Default value: 7 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/info.py b/src/coingecko_sdk/resources/onchain/networks/tokens/info.py index 15a884a..1bbd38b 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/info.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/info.py @@ -53,9 +53,8 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> InfoGetResponse: """ - This endpoint allows you to **query token metadata (name, symbol, CoinGecko ID, - image, socials, websites, description, etc.) based on a provided token contract - address on a network** + To query token metadata (name, symbol, CoinGecko ID, image, socials, websites, + description, etc.) based on a provided token contract address on a network Args: extra_headers: Send extra headers @@ -112,9 +111,8 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> InfoGetResponse: """ - This endpoint allows you to **query token metadata (name, symbol, CoinGecko ID, - image, socials, websites, description, etc.) based on a provided token contract - address on a network** + To query token metadata (name, symbol, CoinGecko ID, image, socials, websites, + description, etc.) based on a provided token contract address on a network Args: extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/multi.py b/src/coingecko_sdk/resources/onchain/networks/tokens/multi.py index c0a023b..ef8b670 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/multi.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/multi.py @@ -59,15 +59,15 @@ def get_addresses( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MultiGetAddressesResponse: """ - This endpoint allows you to **query multiple tokens data based on the provided - token contract addresses on a network** + To query multiple tokens data based on the provided token contract addresses on + a network Args: - include: attributes to include + include: Attributes to include. - include_composition: include pool composition, default: false + include_composition: Include pool composition. Default: `false` - include_inactive_source: include tokens from inactive pools using the most recent swap, default: false + include_inactive_source: Include tokens from inactive pools using the most recent swap. Default: `false` extra_headers: Send extra headers @@ -137,15 +137,15 @@ async def get_addresses( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MultiGetAddressesResponse: """ - This endpoint allows you to **query multiple tokens data based on the provided - token contract addresses on a network** + To query multiple tokens data based on the provided token contract addresses on + a network Args: - include: attributes to include + include: Attributes to include. - include_composition: include pool composition, default: false + include_composition: Include pool composition. Default: `false` - include_inactive_source: include tokens from inactive pools using the most recent swap, default: false + include_inactive_source: Include tokens from inactive pools using the most recent swap. Default: `false` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/ohlcv.py b/src/coingecko_sdk/resources/onchain/networks/tokens/ohlcv.py index c8634bc..e2c7319 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/ohlcv.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/ohlcv.py @@ -63,25 +63,25 @@ def get_timeframe( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> OhlcvGetTimeframeResponse: """ - This endpoint allows you to **get the OHLCV chart (Open, High, Low, Close, - Volume) of a token based on the provided token address on a network** + To get the OHLCV chart (Open, High, Low, Close, Volume) of a token based on the + provided token address on a network Args: - aggregate: time period to aggregate each OHLCV Available values (day): `1` Available values - (hour): `1` , `4` , `12` Available values (minute): `1` , `5` , `15` Available - values (second): `1`, `15`, `30` Default value: 1 + aggregate: Time period to aggregate each OHLCV. Available values (day): `1` Available + values (hour): `1`, `4`, `12` Available values (minute): `1`, `5`, `15` + Available values (second): `1`, `15`, `30` Default value: 1 - before_timestamp: return OHLCV data before this timestamp (integer seconds since epoch) + before_timestamp: Return OHLCV data before this timestamp (integer seconds since epoch). - currency: return OHLCV in USD or quote token Default value: usd + currency: Return OHLCV in USD or quote token. Default: `usd` - include_empty_intervals: include empty intervals with no trade data, default: false + include_empty_intervals: Include empty intervals with no trade data. Default: `false` include_inactive_source: - include token data from inactive pools using the most recent swap, default: - false + Include token data from inactive pools using the most recent swap. Default: + `false` - limit: number of OHLCV results to return, maximum 1000 Default value: 100 + limit: Number of OHLCV results to return, maximum 1000. Default value: 100 extra_headers: Send extra headers @@ -165,25 +165,25 @@ async def get_timeframe( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> OhlcvGetTimeframeResponse: """ - This endpoint allows you to **get the OHLCV chart (Open, High, Low, Close, - Volume) of a token based on the provided token address on a network** + To get the OHLCV chart (Open, High, Low, Close, Volume) of a token based on the + provided token address on a network Args: - aggregate: time period to aggregate each OHLCV Available values (day): `1` Available values - (hour): `1` , `4` , `12` Available values (minute): `1` , `5` , `15` Available - values (second): `1`, `15`, `30` Default value: 1 + aggregate: Time period to aggregate each OHLCV. Available values (day): `1` Available + values (hour): `1`, `4`, `12` Available values (minute): `1`, `5`, `15` + Available values (second): `1`, `15`, `30` Default value: 1 - before_timestamp: return OHLCV data before this timestamp (integer seconds since epoch) + before_timestamp: Return OHLCV data before this timestamp (integer seconds since epoch). - currency: return OHLCV in USD or quote token Default value: usd + currency: Return OHLCV in USD or quote token. Default: `usd` - include_empty_intervals: include empty intervals with no trade data, default: false + include_empty_intervals: Include empty intervals with no trade data. Default: `false` include_inactive_source: - include token data from inactive pools using the most recent swap, default: - false + Include token data from inactive pools using the most recent swap. Default: + `false` - limit: number of OHLCV results to return, maximum 1000 Default value: 100 + limit: Number of OHLCV results to return, maximum 1000. Default value: 100 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/pools.py b/src/coingecko_sdk/resources/onchain/networks/tokens/pools.py index cbd6886..a69c176 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/pools.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/pools.py @@ -61,21 +61,21 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PoolGetResponse: """ - This endpoint allows you to **query top pools based on the provided token - contract address on a network** + To query top pools based on the provided token contract address on a network Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - include_inactive_source: include tokens from inactive pools using the most recent swap, default: false + include_inactive_source: Include tokens from inactive pools using the most recent swap. Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 - sort: sort the pools by field Default value: h24_volume_usd_liquidity_desc + sort: Sort the pools by field. Default: `h24_volume_usd_liquidity_desc` extra_headers: Send extra headers @@ -151,21 +151,21 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PoolGetResponse: """ - This endpoint allows you to **query top pools based on the provided token - contract address on a network** + To query top pools based on the provided token contract address on a network Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - include_inactive_source: include tokens from inactive pools using the most recent swap, default: false + include_inactive_source: Include tokens from inactive pools using the most recent swap. Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 - sort: sort the pools by field Default value: h24_volume_usd_liquidity_desc + sort: Sort the pools by field. Default: `h24_volume_usd_liquidity_desc` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/tokens.py b/src/coingecko_sdk/resources/onchain/networks/tokens/tokens.py index a5dab5e..bb7b00f 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/tokens.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/tokens.py @@ -89,20 +89,16 @@ class TokensResource(SyncAPIResource): @cached_property - def multi(self) -> MultiResource: - return MultiResource(self._client) + def holders_chart(self) -> HoldersChartResource: + return HoldersChartResource(self._client) @cached_property def info(self) -> InfoResource: return InfoResource(self._client) @cached_property - def top_holders(self) -> TopHoldersResource: - return TopHoldersResource(self._client) - - @cached_property - def holders_chart(self) -> HoldersChartResource: - return HoldersChartResource(self._client) + def multi(self) -> MultiResource: + return MultiResource(self._client) @cached_property def ohlcv(self) -> OhlcvResource: @@ -113,13 +109,17 @@ def pools(self) -> PoolsResource: return PoolsResource(self._client) @cached_property - def trades(self) -> TradesResource: - return TradesResource(self._client) + def top_holders(self) -> TopHoldersResource: + return TopHoldersResource(self._client) @cached_property def top_traders(self) -> TopTradersResource: return TopTradersResource(self._client) + @cached_property + def trades(self) -> TradesResource: + return TradesResource(self._client) + @cached_property def with_raw_response(self) -> TokensResourceWithRawResponse: """ @@ -155,17 +155,17 @@ def get_address( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TokenGetAddressResponse: """ - This endpoint allows you to **query specific token data based on the provided - token contract address on a network** + To query specific token data based on the provided token contract address on a + network Args: - include: attributes to include + include: Attributes to include. - include_composition: include pool composition, default: false + include_composition: Include pool composition. Default: `false` include_inactive_source: - include token data from inactive pools using the most recent swap, default: - false + Include token data from inactive pools using the most recent swap. Default: + `false` extra_headers: Send extra headers @@ -201,20 +201,16 @@ def get_address( class AsyncTokensResource(AsyncAPIResource): @cached_property - def multi(self) -> AsyncMultiResource: - return AsyncMultiResource(self._client) + def holders_chart(self) -> AsyncHoldersChartResource: + return AsyncHoldersChartResource(self._client) @cached_property def info(self) -> AsyncInfoResource: return AsyncInfoResource(self._client) @cached_property - def top_holders(self) -> AsyncTopHoldersResource: - return AsyncTopHoldersResource(self._client) - - @cached_property - def holders_chart(self) -> AsyncHoldersChartResource: - return AsyncHoldersChartResource(self._client) + def multi(self) -> AsyncMultiResource: + return AsyncMultiResource(self._client) @cached_property def ohlcv(self) -> AsyncOhlcvResource: @@ -225,13 +221,17 @@ def pools(self) -> AsyncPoolsResource: return AsyncPoolsResource(self._client) @cached_property - def trades(self) -> AsyncTradesResource: - return AsyncTradesResource(self._client) + def top_holders(self) -> AsyncTopHoldersResource: + return AsyncTopHoldersResource(self._client) @cached_property def top_traders(self) -> AsyncTopTradersResource: return AsyncTopTradersResource(self._client) + @cached_property + def trades(self) -> AsyncTradesResource: + return AsyncTradesResource(self._client) + @cached_property def with_raw_response(self) -> AsyncTokensResourceWithRawResponse: """ @@ -267,17 +267,17 @@ async def get_address( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TokenGetAddressResponse: """ - This endpoint allows you to **query specific token data based on the provided - token contract address on a network** + To query specific token data based on the provided token contract address on a + network Args: - include: attributes to include + include: Attributes to include. - include_composition: include pool composition, default: false + include_composition: Include pool composition. Default: `false` include_inactive_source: - include token data from inactive pools using the most recent swap, default: - false + Include token data from inactive pools using the most recent swap. Default: + `false` extra_headers: Send extra headers @@ -320,20 +320,16 @@ def __init__(self, tokens: TokensResource) -> None: ) @cached_property - def multi(self) -> MultiResourceWithRawResponse: - return MultiResourceWithRawResponse(self._tokens.multi) + def holders_chart(self) -> HoldersChartResourceWithRawResponse: + return HoldersChartResourceWithRawResponse(self._tokens.holders_chart) @cached_property def info(self) -> InfoResourceWithRawResponse: return InfoResourceWithRawResponse(self._tokens.info) @cached_property - def top_holders(self) -> TopHoldersResourceWithRawResponse: - return TopHoldersResourceWithRawResponse(self._tokens.top_holders) - - @cached_property - def holders_chart(self) -> HoldersChartResourceWithRawResponse: - return HoldersChartResourceWithRawResponse(self._tokens.holders_chart) + def multi(self) -> MultiResourceWithRawResponse: + return MultiResourceWithRawResponse(self._tokens.multi) @cached_property def ohlcv(self) -> OhlcvResourceWithRawResponse: @@ -344,13 +340,17 @@ def pools(self) -> PoolsResourceWithRawResponse: return PoolsResourceWithRawResponse(self._tokens.pools) @cached_property - def trades(self) -> TradesResourceWithRawResponse: - return TradesResourceWithRawResponse(self._tokens.trades) + def top_holders(self) -> TopHoldersResourceWithRawResponse: + return TopHoldersResourceWithRawResponse(self._tokens.top_holders) @cached_property def top_traders(self) -> TopTradersResourceWithRawResponse: return TopTradersResourceWithRawResponse(self._tokens.top_traders) + @cached_property + def trades(self) -> TradesResourceWithRawResponse: + return TradesResourceWithRawResponse(self._tokens.trades) + class AsyncTokensResourceWithRawResponse: def __init__(self, tokens: AsyncTokensResource) -> None: @@ -361,20 +361,16 @@ def __init__(self, tokens: AsyncTokensResource) -> None: ) @cached_property - def multi(self) -> AsyncMultiResourceWithRawResponse: - return AsyncMultiResourceWithRawResponse(self._tokens.multi) + def holders_chart(self) -> AsyncHoldersChartResourceWithRawResponse: + return AsyncHoldersChartResourceWithRawResponse(self._tokens.holders_chart) @cached_property def info(self) -> AsyncInfoResourceWithRawResponse: return AsyncInfoResourceWithRawResponse(self._tokens.info) @cached_property - def top_holders(self) -> AsyncTopHoldersResourceWithRawResponse: - return AsyncTopHoldersResourceWithRawResponse(self._tokens.top_holders) - - @cached_property - def holders_chart(self) -> AsyncHoldersChartResourceWithRawResponse: - return AsyncHoldersChartResourceWithRawResponse(self._tokens.holders_chart) + def multi(self) -> AsyncMultiResourceWithRawResponse: + return AsyncMultiResourceWithRawResponse(self._tokens.multi) @cached_property def ohlcv(self) -> AsyncOhlcvResourceWithRawResponse: @@ -385,13 +381,17 @@ def pools(self) -> AsyncPoolsResourceWithRawResponse: return AsyncPoolsResourceWithRawResponse(self._tokens.pools) @cached_property - def trades(self) -> AsyncTradesResourceWithRawResponse: - return AsyncTradesResourceWithRawResponse(self._tokens.trades) + def top_holders(self) -> AsyncTopHoldersResourceWithRawResponse: + return AsyncTopHoldersResourceWithRawResponse(self._tokens.top_holders) @cached_property def top_traders(self) -> AsyncTopTradersResourceWithRawResponse: return AsyncTopTradersResourceWithRawResponse(self._tokens.top_traders) + @cached_property + def trades(self) -> AsyncTradesResourceWithRawResponse: + return AsyncTradesResourceWithRawResponse(self._tokens.trades) + class TokensResourceWithStreamingResponse: def __init__(self, tokens: TokensResource) -> None: @@ -402,20 +402,16 @@ def __init__(self, tokens: TokensResource) -> None: ) @cached_property - def multi(self) -> MultiResourceWithStreamingResponse: - return MultiResourceWithStreamingResponse(self._tokens.multi) + def holders_chart(self) -> HoldersChartResourceWithStreamingResponse: + return HoldersChartResourceWithStreamingResponse(self._tokens.holders_chart) @cached_property def info(self) -> InfoResourceWithStreamingResponse: return InfoResourceWithStreamingResponse(self._tokens.info) @cached_property - def top_holders(self) -> TopHoldersResourceWithStreamingResponse: - return TopHoldersResourceWithStreamingResponse(self._tokens.top_holders) - - @cached_property - def holders_chart(self) -> HoldersChartResourceWithStreamingResponse: - return HoldersChartResourceWithStreamingResponse(self._tokens.holders_chart) + def multi(self) -> MultiResourceWithStreamingResponse: + return MultiResourceWithStreamingResponse(self._tokens.multi) @cached_property def ohlcv(self) -> OhlcvResourceWithStreamingResponse: @@ -426,13 +422,17 @@ def pools(self) -> PoolsResourceWithStreamingResponse: return PoolsResourceWithStreamingResponse(self._tokens.pools) @cached_property - def trades(self) -> TradesResourceWithStreamingResponse: - return TradesResourceWithStreamingResponse(self._tokens.trades) + def top_holders(self) -> TopHoldersResourceWithStreamingResponse: + return TopHoldersResourceWithStreamingResponse(self._tokens.top_holders) @cached_property def top_traders(self) -> TopTradersResourceWithStreamingResponse: return TopTradersResourceWithStreamingResponse(self._tokens.top_traders) + @cached_property + def trades(self) -> TradesResourceWithStreamingResponse: + return TradesResourceWithStreamingResponse(self._tokens.trades) + class AsyncTokensResourceWithStreamingResponse: def __init__(self, tokens: AsyncTokensResource) -> None: @@ -443,20 +443,16 @@ def __init__(self, tokens: AsyncTokensResource) -> None: ) @cached_property - def multi(self) -> AsyncMultiResourceWithStreamingResponse: - return AsyncMultiResourceWithStreamingResponse(self._tokens.multi) + def holders_chart(self) -> AsyncHoldersChartResourceWithStreamingResponse: + return AsyncHoldersChartResourceWithStreamingResponse(self._tokens.holders_chart) @cached_property def info(self) -> AsyncInfoResourceWithStreamingResponse: return AsyncInfoResourceWithStreamingResponse(self._tokens.info) @cached_property - def top_holders(self) -> AsyncTopHoldersResourceWithStreamingResponse: - return AsyncTopHoldersResourceWithStreamingResponse(self._tokens.top_holders) - - @cached_property - def holders_chart(self) -> AsyncHoldersChartResourceWithStreamingResponse: - return AsyncHoldersChartResourceWithStreamingResponse(self._tokens.holders_chart) + def multi(self) -> AsyncMultiResourceWithStreamingResponse: + return AsyncMultiResourceWithStreamingResponse(self._tokens.multi) @cached_property def ohlcv(self) -> AsyncOhlcvResourceWithStreamingResponse: @@ -467,9 +463,13 @@ def pools(self) -> AsyncPoolsResourceWithStreamingResponse: return AsyncPoolsResourceWithStreamingResponse(self._tokens.pools) @cached_property - def trades(self) -> AsyncTradesResourceWithStreamingResponse: - return AsyncTradesResourceWithStreamingResponse(self._tokens.trades) + def top_holders(self) -> AsyncTopHoldersResourceWithStreamingResponse: + return AsyncTopHoldersResourceWithStreamingResponse(self._tokens.top_holders) @cached_property def top_traders(self) -> AsyncTopTradersResourceWithStreamingResponse: return AsyncTopTradersResourceWithStreamingResponse(self._tokens.top_traders) + + @cached_property + def trades(self) -> AsyncTradesResourceWithStreamingResponse: + return AsyncTradesResourceWithStreamingResponse(self._tokens.trades) diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/top_holders.py b/src/coingecko_sdk/resources/onchain/networks/tokens/top_holders.py index b946e5e..babe192 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/top_holders.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/top_holders.py @@ -56,14 +56,13 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TopHolderGetResponse: """ - This endpoint allows you to **query top token holders based on the provided - token contract address on a network** + To query top token holders based on the provided token contract address on a + network Args: - holders: number of top token holders to return, you may use any integer or `max` Default - value: 10 + holders: Number of top token holders to return, any integer or `max`. Default value: 10 - include_pnl_details: include PnL details for token holders, default: false + include_pnl_details: Include PnL details for token holders. Default: `false` extra_headers: Send extra headers @@ -131,14 +130,13 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TopHolderGetResponse: """ - This endpoint allows you to **query top token holders based on the provided - token contract address on a network** + To query top token holders based on the provided token contract address on a + network Args: - holders: number of top token holders to return, you may use any integer or `max` Default - value: 10 + holders: Number of top token holders to return, any integer or `max`. Default value: 10 - include_pnl_details: include PnL details for token holders, default: false + include_pnl_details: Include PnL details for token holders. Default: `false` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/top_traders.py b/src/coingecko_sdk/resources/onchain/networks/tokens/top_traders.py index 4c88632..b375f46 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/top_traders.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/top_traders.py @@ -60,16 +60,15 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TopTraderGetResponse: """ - This endpoint allows you to **query top token traders based on the provided - token contract address on a network** + To query top token traders based on the provided token contract address on a + network Args: - include_address_label: include address label data, default: false + include_address_label: Include address label data. Default: `false` - sort: sort the traders by field Default value: realized_pnl_usd_desc + sort: Sort the traders by field. Default: `realized_pnl_usd_desc` - traders: number of top token traders to return, you may use any integer or `max` Default - value: 10 + traders: Number of top token traders to return, any integer or `max`. Default value: 10 extra_headers: Send extra headers @@ -144,16 +143,15 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TopTraderGetResponse: """ - This endpoint allows you to **query top token traders based on the provided - token contract address on a network** + To query top token traders based on the provided token contract address on a + network Args: - include_address_label: include address label data, default: false + include_address_label: Include address label data. Default: `false` - sort: sort the traders by field Default value: realized_pnl_usd_desc + sort: Sort the traders by field. Default: `realized_pnl_usd_desc` - traders: number of top token traders to return, you may use any integer or `max` Default - value: 10 + traders: Number of top token traders to return, any integer or `max`. Default value: 10 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/tokens/trades.py b/src/coingecko_sdk/resources/onchain/networks/tokens/trades.py index 8277869..d672ed5 100644 --- a/src/coingecko_sdk/resources/onchain/networks/tokens/trades.py +++ b/src/coingecko_sdk/resources/onchain/networks/tokens/trades.py @@ -55,11 +55,11 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TradeGetResponse: """ - This endpoint allows you to **query the last 300 trades in the past 24 hours, - across all pools, based on the provided token contract address on a network** + To query the last 300 trades in the past 24 hours, across all pools, based on + the provided token contract address on a network Args: - trade_volume_in_usd_greater_than: filter trades by trade volume in USD greater than this value Default value: 0 + trade_volume_in_usd_greater_than: Filter trades by trade volume in USD greater than this value. Default value: 0 extra_headers: Send extra headers @@ -127,11 +127,11 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TradeGetResponse: """ - This endpoint allows you to **query the last 300 trades in the past 24 hours, - across all pools, based on the provided token contract address on a network** + To query the last 300 trades in the past 24 hours, across all pools, based on + the provided token contract address on a network Args: - trade_volume_in_usd_greater_than: filter trades by trade volume in USD greater than this value Default value: 0 + trade_volume_in_usd_greater_than: Filter trades by trade volume in USD greater than this value. Default value: 0 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/networks/trending_pools.py b/src/coingecko_sdk/resources/onchain/networks/trending_pools.py index edc1052..cc028bd 100644 --- a/src/coingecko_sdk/resources/onchain/networks/trending_pools.py +++ b/src/coingecko_sdk/resources/onchain/networks/trending_pools.py @@ -59,20 +59,19 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TrendingPoolGetResponse: """ - This endpoint allows you to **query all the trending pools across all networks - on GeckoTerminal** + To query all the trending pools across all networks on GeckoTerminal Args: - duration: duration to sort trending list by Default value: 24h + duration: Duration to sort trending list by. Default: `24h` - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network`. Example: `base_token` or - `base_token,dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -118,19 +117,19 @@ def get_network( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TrendingPoolGetNetworkResponse: """ - This endpoint allows you to **query the trending pools based on the provided - network** + To query the trending pools based on the provided network Args: - duration: duration to sort trending list by Default value: 24h + duration: Duration to sort trending list by. Default: `24h` - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -198,20 +197,19 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TrendingPoolGetResponse: """ - This endpoint allows you to **query all the trending pools across all networks - on GeckoTerminal** + To query all the trending pools across all networks on GeckoTerminal Args: - duration: duration to sort trending list by Default value: 24h + duration: Duration to sort trending list by. Default: `24h` - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network`. Example: `base_token` or - `base_token,dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers @@ -257,19 +255,19 @@ async def get_network( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TrendingPoolGetNetworkResponse: """ - This endpoint allows you to **query the trending pools based on the provided - network** + To query the trending pools based on the provided network Args: - duration: duration to sort trending list by Default value: 24h + duration: Duration to sort trending list by. Default: `24h` - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - include_gt_community_data: include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + include_gt_community_data: Include GeckoTerminal community data (sentiment votes, suspicious reports). + Default: `false` - page: page through results Default value: 1 + page: Page through results. Default value: 1 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/pools/megafilter.py b/src/coingecko_sdk/resources/onchain/pools/megafilter.py index e2c41c6..e5bfb53 100644 --- a/src/coingecko_sdk/resources/onchain/pools/megafilter.py +++ b/src/coingecko_sdk/resources/onchain/pools/megafilter.py @@ -110,76 +110,76 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MegafilterGetResponse: """ - This endpoint allows you to **query pools based on various filters across all - networks on GeckoTerminal** + To query pools based on various filters across all networks on GeckoTerminal Args: - buy_tax_percentage_max: maximum buy tax percentage + buy_tax_percentage_max: Maximum buy tax percentage. - buy_tax_percentage_min: minimum buy tax percentage + buy_tax_percentage_min: Minimum buy tax percentage. - buys_duration: duration for buy transactions metric Default value: 24h + buys_duration: Duration for buy transactions metric. Default: `24h` - buys_max: maximum number of buy transactions + buys_max: Maximum number of buy transactions. - buys_min: minimum number of buy transactions + buys_min: Minimum number of buy transactions. - checks: filter options for various checks, comma-separated if more than one Available + checks: Filter options for various checks, comma-separated if more than one. Available values: `no_honeypot`, `good_gt_score`, `on_coingecko`, `has_social` - dexes: filter pools by DEXes, comma-separated if more than one DEX ID refers to - [/networks/{network}/dexes](/reference/dexes-list) + dexes: Filter pools by DEXes, comma-separated if more than one. \\**refers to + [`/onchain/networks/{network}/dexes`](/reference/dexes-list). - fdv_usd_max: maximum fully diluted value in USD + fdv_usd_max: Maximum fully diluted value in USD. - fdv_usd_min: minimum fully diluted value in USD + fdv_usd_min: Minimum fully diluted value in USD. - h24_volume_usd_max: maximum 24hr volume in USD + h24_volume_usd_max: Maximum 24hr volume in USD. - h24_volume_usd_min: minimum 24hr volume in USD + h24_volume_usd_min: Minimum 24hr volume in USD. - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - include_unknown_honeypot_tokens: when `checks` includes `no_honeypot`, set to **`true`** to also include 'unknown - honeypot' tokens. Default value: `false` + include_unknown_honeypot_tokens: When `checks` includes `no_honeypot`, set to `true` to also include unknown + honeypot tokens. Default: `false` - networks: filter pools by networks, comma-separated if more than one Network ID refers to - [/networks](/reference/networks-list) + networks: Filter pools by networks, comma-separated if more than one. \\**refers to + [`/onchain/networks`](/reference/networks-list). - page: page through results Default value: 1 + page: Page through results. Default value: 1 - pool_created_hour_max: maximum pool age in hours + pool_created_hour_max: Maximum pool age in hours. - pool_created_hour_min: minimum pool age in hours + pool_created_hour_min: Minimum pool age in hours. - price_change_percentage_duration: duration for price change percentage metric + price_change_percentage_duration: Duration for price change percentage metric. Default: `24h` - price_change_percentage_max: maximum price change percentage + price_change_percentage_max: Maximum price change percentage. - price_change_percentage_min: minimum price change percentage + price_change_percentage_min: Minimum price change percentage. - reserve_in_usd_max: maximum reserve in USD + reserve_in_usd_max: Maximum reserve in USD. - reserve_in_usd_min: minimum reserve in USD + reserve_in_usd_min: Minimum reserve in USD. - sell_tax_percentage_max: maximum sell tax percentage + sell_tax_percentage_max: Maximum sell tax percentage. - sell_tax_percentage_min: minimum sell tax percentage + sell_tax_percentage_min: Minimum sell tax percentage. - sells_duration: duration for sell transactions metric Default value: 24h + sells_duration: Duration for sell transactions metric. Default: `24h` - sells_max: maximum number of sell transactions + sells_max: Maximum number of sell transactions. - sells_min: minimum number of sell transactions + sells_min: Minimum number of sell transactions. - sort: sort the pools by field Default value: h6_trending + sort: Sort the pools by field. Default: `h6_trending` - tx_count_duration: duration for transaction count metric Default value: 24h + tx_count_duration: Duration for transaction count metric. Default: `24h` - tx_count_max: maximum transaction count + tx_count_max: Maximum transaction count. - tx_count_min: minimum transaction count + tx_count_min: Minimum transaction count. extra_headers: Send extra headers @@ -324,76 +324,76 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> MegafilterGetResponse: """ - This endpoint allows you to **query pools based on various filters across all - networks on GeckoTerminal** + To query pools based on various filters across all networks on GeckoTerminal Args: - buy_tax_percentage_max: maximum buy tax percentage + buy_tax_percentage_max: Maximum buy tax percentage. - buy_tax_percentage_min: minimum buy tax percentage + buy_tax_percentage_min: Minimum buy tax percentage. - buys_duration: duration for buy transactions metric Default value: 24h + buys_duration: Duration for buy transactions metric. Default: `24h` - buys_max: maximum number of buy transactions + buys_max: Maximum number of buy transactions. - buys_min: minimum number of buy transactions + buys_min: Minimum number of buy transactions. - checks: filter options for various checks, comma-separated if more than one Available + checks: Filter options for various checks, comma-separated if more than one. Available values: `no_honeypot`, `good_gt_score`, `on_coingecko`, `has_social` - dexes: filter pools by DEXes, comma-separated if more than one DEX ID refers to - [/networks/{network}/dexes](/reference/dexes-list) + dexes: Filter pools by DEXes, comma-separated if more than one. \\**refers to + [`/onchain/networks/{network}/dexes`](/reference/dexes-list). - fdv_usd_max: maximum fully diluted value in USD + fdv_usd_max: Maximum fully diluted value in USD. - fdv_usd_min: minimum fully diluted value in USD + fdv_usd_min: Minimum fully diluted value in USD. - h24_volume_usd_max: maximum 24hr volume in USD + h24_volume_usd_max: Maximum 24hr volume in USD. - h24_volume_usd_min: minimum 24hr volume in USD + h24_volume_usd_min: Minimum 24hr volume in USD. - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - include_unknown_honeypot_tokens: when `checks` includes `no_honeypot`, set to **`true`** to also include 'unknown - honeypot' tokens. Default value: `false` + include_unknown_honeypot_tokens: When `checks` includes `no_honeypot`, set to `true` to also include unknown + honeypot tokens. Default: `false` - networks: filter pools by networks, comma-separated if more than one Network ID refers to - [/networks](/reference/networks-list) + networks: Filter pools by networks, comma-separated if more than one. \\**refers to + [`/onchain/networks`](/reference/networks-list). - page: page through results Default value: 1 + page: Page through results. Default value: 1 - pool_created_hour_max: maximum pool age in hours + pool_created_hour_max: Maximum pool age in hours. - pool_created_hour_min: minimum pool age in hours + pool_created_hour_min: Minimum pool age in hours. - price_change_percentage_duration: duration for price change percentage metric + price_change_percentage_duration: Duration for price change percentage metric. Default: `24h` - price_change_percentage_max: maximum price change percentage + price_change_percentage_max: Maximum price change percentage. - price_change_percentage_min: minimum price change percentage + price_change_percentage_min: Minimum price change percentage. - reserve_in_usd_max: maximum reserve in USD + reserve_in_usd_max: Maximum reserve in USD. - reserve_in_usd_min: minimum reserve in USD + reserve_in_usd_min: Minimum reserve in USD. - sell_tax_percentage_max: maximum sell tax percentage + sell_tax_percentage_max: Maximum sell tax percentage. - sell_tax_percentage_min: minimum sell tax percentage + sell_tax_percentage_min: Minimum sell tax percentage. - sells_duration: duration for sell transactions metric Default value: 24h + sells_duration: Duration for sell transactions metric. Default: `24h` - sells_max: maximum number of sell transactions + sells_max: Maximum number of sell transactions. - sells_min: minimum number of sell transactions + sells_min: Minimum number of sell transactions. - sort: sort the pools by field Default value: h6_trending + sort: Sort the pools by field. Default: `h6_trending` - tx_count_duration: duration for transaction count metric Default value: 24h + tx_count_duration: Duration for transaction count metric. Default: `24h` - tx_count_max: maximum transaction count + tx_count_max: Maximum transaction count. - tx_count_min: minimum transaction count + tx_count_min: Minimum transaction count. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/pools/trending_search.py b/src/coingecko_sdk/resources/onchain/pools/trending_search.py index 5da1d5e..8558d53 100644 --- a/src/coingecko_sdk/resources/onchain/pools/trending_search.py +++ b/src/coingecko_sdk/resources/onchain/pools/trending_search.py @@ -54,14 +54,14 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TrendingSearchGetResponse: """ - This endpoint allows you to **query all the trending search pools across all - networks on GeckoTerminal** + To query all the trending search pools across all networks on GeckoTerminal Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - pools: number of pools to return, maximum 10 Default value: 4 + pools: Number of pools to return, maximum 10. Default value: 4 extra_headers: Send extra headers @@ -123,14 +123,14 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TrendingSearchGetResponse: """ - This endpoint allows you to **query all the trending search pools across all - networks on GeckoTerminal** + To query all the trending search pools across all networks on GeckoTerminal Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex`, `network` - pools: number of pools to return, maximum 10 Default value: 4 + pools: Number of pools to return, maximum 10. Default value: 4 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/search/pools.py b/src/coingecko_sdk/resources/onchain/search/pools.py index e54acd8..a335980 100644 --- a/src/coingecko_sdk/resources/onchain/search/pools.py +++ b/src/coingecko_sdk/resources/onchain/search/pools.py @@ -56,19 +56,20 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PoolGetResponse: """ - This endpoint allows you to **search for pools on a network by pool address, - token name, token symbol, or token contract address** + To search for pools across all networks by pool address, token name, token + symbol, or token contract address Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - network: network ID \\**refers to [/networks](/reference/networks-list) + network: Network ID. \\**refers to [`/onchain/networks`](/reference/networks-list). - page: page through results Default value: 1 + page: Page through results. Default value: 1 - query: search query, can be pool contract address, token name, token symbol, or token - contract address + query: Search query: pool contract address, token name, token symbol, or token contract + address. extra_headers: Send extra headers @@ -134,19 +135,20 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PoolGetResponse: """ - This endpoint allows you to **search for pools on a network by pool address, - token name, token symbol, or token contract address** + To search for pools across all networks by pool address, token name, token + symbol, or token contract address Args: - include: attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + include: + Attributes to include, comma-separated if more than one. Available values: + `base_token`, `quote_token`, `dex` - network: network ID \\**refers to [/networks](/reference/networks-list) + network: Network ID. \\**refers to [`/onchain/networks`](/reference/networks-list). - page: page through results Default value: 1 + page: Page through results. Default value: 1 - query: search query, can be pool contract address, token name, token symbol, or token - contract address + query: Search query: pool contract address, token name, token symbol, or token contract + address. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/simple/networks/token_price.py b/src/coingecko_sdk/resources/onchain/simple/networks/token_price.py index 302c132..272e836 100644 --- a/src/coingecko_sdk/resources/onchain/simple/networks/token_price.py +++ b/src/coingecko_sdk/resources/onchain/simple/networks/token_price.py @@ -60,22 +60,21 @@ def get_addresses( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TokenPriceGetAddressesResponse: """ - This endpoint allows you to **get token price based on the provided token - contract address on a network** + To get token price based on the provided token contract address on a network Args: - include_24hr_price_change: include 24hr price change, default: false + include_24hr_price_change: Include 24hr price change. Default: `false` - include_24hr_vol: include 24hr volume, default: false + include_24hr_vol: Include 24hr volume. Default: `false` - include_inactive_source: include token price data from inactive pools using the most recent swap, - default: false + include_inactive_source: Include token price data from inactive pools using the most recent swap. + Default: `false` - include_market_cap: include market capitalization, default: false + include_market_cap: Include market capitalization. Default: `false` - include_total_reserve_in_usd: include total reserve in USD, default: false + include_total_reserve_in_usd: Include total reserve in USD. Default: `false` - mcap_fdv_fallback: return FDV if market cap is not available, default: false + mcap_fdv_fallback: Return FDV if market cap is not available. Default: `false` extra_headers: Send extra headers @@ -153,22 +152,21 @@ async def get_addresses( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TokenPriceGetAddressesResponse: """ - This endpoint allows you to **get token price based on the provided token - contract address on a network** + To get token price based on the provided token contract address on a network Args: - include_24hr_price_change: include 24hr price change, default: false + include_24hr_price_change: Include 24hr price change. Default: `false` - include_24hr_vol: include 24hr volume, default: false + include_24hr_vol: Include 24hr volume. Default: `false` - include_inactive_source: include token price data from inactive pools using the most recent swap, - default: false + include_inactive_source: Include token price data from inactive pools using the most recent swap. + Default: `false` - include_market_cap: include market capitalization, default: false + include_market_cap: Include market capitalization. Default: `false` - include_total_reserve_in_usd: include total reserve in USD, default: false + include_total_reserve_in_usd: Include total reserve in USD. Default: `false` - mcap_fdv_fallback: return FDV if market cap is not available, default: false + mcap_fdv_fallback: Return FDV if market cap is not available. Default: `false` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/onchain/tokens/info_recently_updated.py b/src/coingecko_sdk/resources/onchain/tokens/info_recently_updated.py index 98378fe..cfb2d82 100644 --- a/src/coingecko_sdk/resources/onchain/tokens/info_recently_updated.py +++ b/src/coingecko_sdk/resources/onchain/tokens/info_recently_updated.py @@ -56,15 +56,14 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> InfoRecentlyUpdatedGetResponse: """ - This endpoint allows you to **query 100 most recently updated tokens info of a - specific network or across all networks on GeckoTerminal** + To query 100 most recently updated tokens info of a specific network or across + all networks on GeckoTerminal Args: - include: Attributes for related resources to include, which will be returned under the - top-level 'included' key + include: Attributes for related resources to include. - network: filter tokens by provided network \\**refers to - [/networks](/reference/networks-list) + network: Filter tokens by provided network. \\**refers to + [`/onchain/networks`](/reference/networks-list). extra_headers: Send extra headers @@ -126,15 +125,14 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> InfoRecentlyUpdatedGetResponse: """ - This endpoint allows you to **query 100 most recently updated tokens info of a - specific network or across all networks on GeckoTerminal** + To query 100 most recently updated tokens info of a specific network or across + all networks on GeckoTerminal Args: - include: Attributes for related resources to include, which will be returned under the - top-level 'included' key + include: Attributes for related resources to include. - network: filter tokens by provided network \\**refers to - [/networks](/reference/networks-list) + network: Filter tokens by provided network. \\**refers to + [`/onchain/networks`](/reference/networks-list). extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/ping.py b/src/coingecko_sdk/resources/ping.py index 94122f6..97b27e5 100644 --- a/src/coingecko_sdk/resources/ping.py +++ b/src/coingecko_sdk/resources/ping.py @@ -49,7 +49,7 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PingGetResponse: - """This endpoint allows you to **check the API server status**""" + """To check the API server status""" return self._get( "/ping", options=make_request_options( @@ -89,7 +89,7 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PingGetResponse: - """This endpoint allows you to **check the API server status**""" + """To check the API server status""" return await self._get( "/ping", options=make_request_options( diff --git a/src/coingecko_sdk/resources/public_treasury.py b/src/coingecko_sdk/resources/public_treasury.py index 36f24d8..e681221 100644 --- a/src/coingecko_sdk/resources/public_treasury.py +++ b/src/coingecko_sdk/resources/public_treasury.py @@ -68,15 +68,14 @@ def get_coin_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PublicTreasuryGetCoinIDResponse: """ - This endpoint allows you **query public companies & governments' cryptocurrency - holdings** by Coin ID + To query public companies' and governments' cryptocurrency holdings by coin ID Args: - order: Sort order for results + order: Sort order for results. Default: `total_holdings_usd_desc` - page: Page number to return + page: Page through results. Default value: 1 - per_page: Number of results to return per page + per_page: Total results per page. Default value: 250 Valid values: 1...250 extra_headers: Send extra headers @@ -128,15 +127,16 @@ def get_entity_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PublicTreasuryGetEntityIDResponse: """ - This endpoint allows you **query public companies & governments' cryptocurrency - holdings** by Entity ID + To query public companies' and governments' cryptocurrency holdings by entity ID Args: - holding_amount_change: include holding amount change for specified timeframes, comma-separated if - querying more than 1 timeframe Valid values: 7d, 14d, 30d, 90d, 1y, ytd + holding_amount_change: Include holding amount change for specified timeframes, comma-separated if + querying more than 1 timeframe. Valid values: `7d`, `14d`, `30d`, `90d`, `1y`, + `ytd` - holding_change_percentage: include holding change percentage for specified timeframes, comma-separated if - querying more than 1 timeframe Valid values: 7d, 14d, 30d, 90d, 1y, ytd + holding_change_percentage: Include holding change percentage for specified timeframes, comma-separated if + querying more than 1 timeframe. Valid values: `7d`, `14d`, `30d`, `90d`, `1y`, + `ytd` extra_headers: Send extra headers @@ -181,13 +181,14 @@ def get_holding_chart( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PublicTreasuryGetHoldingChartResponse: """ - This endpoint allows you to **query historical cryptocurrency holdings chart of - public companies & governments** by Entity ID and Coin ID + To query historical cryptocurrency holdings chart of public companies and + governments by entity ID and coin ID Args: - days: data up to number of days ago Valid values: `7, 14, 30, 90, 180, 365, 730, max` + days: Data up to number of days ago. Valid values: `7`, `14`, `30`, `90`, `180`, + `365`, `730`, `max` - include_empty_intervals: include empty intervals with no transaction data, default: false + include_empty_intervals: Include empty intervals with no transaction data. Default: `false` extra_headers: Send extra headers @@ -235,8 +236,8 @@ def get_transaction_history( "average_cost_asc", ] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -245,18 +246,18 @@ def get_transaction_history( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PublicTreasuryGetTransactionHistoryResponse: """ - This endpoint allows you **query public companies & governments' cryptocurrency - transaction history** by Entity ID + To query public companies' and governments' cryptocurrency transaction history + by entity ID Args: - coin_ids: filter transactions by coin IDs, comma-separated if querying more than 1 coin + coin_ids: Filter transactions by coin IDs, comma-separated if querying more than 1 coin. \\**refers to [`/coins/list`](/reference/coins-list). - order: use this to sort the order of transactions, default: `date_desc` + order: Sort order of transactions. Default: `date_desc` - page: page through results, default: `1` + page: Page through results. Default value: 1 - per_page: total results per page, default: `100` Valid values: 1...250 + per_page: Total results per page. Default value: 100 Valid values: 1...250 extra_headers: Send extra headers @@ -325,15 +326,14 @@ async def get_coin_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PublicTreasuryGetCoinIDResponse: """ - This endpoint allows you **query public companies & governments' cryptocurrency - holdings** by Coin ID + To query public companies' and governments' cryptocurrency holdings by coin ID Args: - order: Sort order for results + order: Sort order for results. Default: `total_holdings_usd_desc` - page: Page number to return + page: Page through results. Default value: 1 - per_page: Number of results to return per page + per_page: Total results per page. Default value: 250 Valid values: 1...250 extra_headers: Send extra headers @@ -385,15 +385,16 @@ async def get_entity_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PublicTreasuryGetEntityIDResponse: """ - This endpoint allows you **query public companies & governments' cryptocurrency - holdings** by Entity ID + To query public companies' and governments' cryptocurrency holdings by entity ID Args: - holding_amount_change: include holding amount change for specified timeframes, comma-separated if - querying more than 1 timeframe Valid values: 7d, 14d, 30d, 90d, 1y, ytd + holding_amount_change: Include holding amount change for specified timeframes, comma-separated if + querying more than 1 timeframe. Valid values: `7d`, `14d`, `30d`, `90d`, `1y`, + `ytd` - holding_change_percentage: include holding change percentage for specified timeframes, comma-separated if - querying more than 1 timeframe Valid values: 7d, 14d, 30d, 90d, 1y, ytd + holding_change_percentage: Include holding change percentage for specified timeframes, comma-separated if + querying more than 1 timeframe. Valid values: `7d`, `14d`, `30d`, `90d`, `1y`, + `ytd` extra_headers: Send extra headers @@ -438,13 +439,14 @@ async def get_holding_chart( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PublicTreasuryGetHoldingChartResponse: """ - This endpoint allows you to **query historical cryptocurrency holdings chart of - public companies & governments** by Entity ID and Coin ID + To query historical cryptocurrency holdings chart of public companies and + governments by entity ID and coin ID Args: - days: data up to number of days ago Valid values: `7, 14, 30, 90, 180, 365, 730, max` + days: Data up to number of days ago. Valid values: `7`, `14`, `30`, `90`, `180`, + `365`, `730`, `max` - include_empty_intervals: include empty intervals with no transaction data, default: false + include_empty_intervals: Include empty intervals with no transaction data. Default: `false` extra_headers: Send extra headers @@ -492,8 +494,8 @@ async def get_transaction_history( "average_cost_asc", ] | Omit = omit, - page: float | Omit = omit, - per_page: float | Omit = omit, + page: int | Omit = omit, + per_page: int | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -502,18 +504,18 @@ async def get_transaction_history( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PublicTreasuryGetTransactionHistoryResponse: """ - This endpoint allows you **query public companies & governments' cryptocurrency - transaction history** by Entity ID + To query public companies' and governments' cryptocurrency transaction history + by entity ID Args: - coin_ids: filter transactions by coin IDs, comma-separated if querying more than 1 coin + coin_ids: Filter transactions by coin IDs, comma-separated if querying more than 1 coin. \\**refers to [`/coins/list`](/reference/coins-list). - order: use this to sort the order of transactions, default: `date_desc` + order: Sort order of transactions. Default: `date_desc` - page: page through results, default: `1` + page: Page through results. Default value: 1 - per_page: total results per page, default: `100` Valid values: 1...250 + per_page: Total results per page. Default value: 100 Valid values: 1...250 extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/search/search.py b/src/coingecko_sdk/resources/search/search.py index 5e529fd..190de86 100644 --- a/src/coingecko_sdk/resources/search/search.py +++ b/src/coingecko_sdk/resources/search/search.py @@ -65,11 +65,10 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> SearchGetResponse: """ - This endpoint allows you to **search for coins, categories and markets listed on - CoinGecko** + To search for coins, categories and markets listed on CoinGecko Args: - query: search query + query: Search query extra_headers: Send extra headers @@ -128,11 +127,10 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> SearchGetResponse: """ - This endpoint allows you to **search for coins, categories and markets listed on - CoinGecko** + To search for coins, categories and markets listed on CoinGecko Args: - query: search query + query: Search query extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/search/trending.py b/src/coingecko_sdk/resources/search/trending.py index 50538dd..f8e42ad 100644 --- a/src/coingecko_sdk/resources/search/trending.py +++ b/src/coingecko_sdk/resources/search/trending.py @@ -53,13 +53,13 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TrendingGetResponse: """ - This endpoint allows you **query trending search coins, NFTs and categories on - CoinGecko in the last 24 hours** + To query trending search coins, NFTs and categories on CoinGecko in the last 24 + hours Args: show_max: - show max number of results available for the given type Available values: - `coins`, `nfts`, `categories` Example: `coins` or `coins,nfts,categories` + Show max number of results available for the given type. Available values: + `coins`, `nfts`, `categories` e.g. `coins` or `coins,nfts,categories` extra_headers: Send extra headers @@ -114,13 +114,13 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TrendingGetResponse: """ - This endpoint allows you **query trending search coins, NFTs and categories on - CoinGecko in the last 24 hours** + To query trending search coins, NFTs and categories on CoinGecko in the last 24 + hours Args: show_max: - show max number of results available for the given type Available values: - `coins`, `nfts`, `categories` Example: `coins` or `coins,nfts,categories` + Show max number of results available for the given type. Available values: + `coins`, `nfts`, `categories` e.g. `coins` or `coins,nfts,categories` extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/simple/price.py b/src/coingecko_sdk/resources/simple/price.py index 2293ed0..afe59c1 100644 --- a/src/coingecko_sdk/resources/simple/price.py +++ b/src/coingecko_sdk/resources/simple/price.py @@ -86,33 +86,33 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PriceGetResponse: """ - This endpoint allows you to **query the prices of one or more coins by using - their unique Coin API IDs, symbols, or names** + To query the prices of one or more coins by using their unique Coin API IDs, + symbols, or names Args: - vs_currencies: target currency of coins, comma-separated if querying more than 1 currency. + vs_currencies: Target currency of coins, comma-separated if querying more than 1 currency. \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) - ids: coins' IDs, comma-separated if querying more than 1 coin. \\**refers to - [`/coins/list`](/reference/coins-list). + ids: Coins' IDs, comma-separated if querying more than 1 coin. \\**refers to + [`/coins/list`](/reference/coins-list) - include_24hr_change: include 24hr change percentage, default: false + include_24hr_change: Include 24-hour change percentage. Default: false - include_24hr_vol: include 24hr volume, default: false + include_24hr_vol: Include 24-hour trading volume. Default: false - include_last_updated_at: include last updated price time in UNIX, default: false + include_last_updated_at: Include last updated price time as a UNIX timestamp. Default: false - include_market_cap: include market capitalization, default: false + include_market_cap: Include market capitalization. Default: false - include_tokens: for `symbols` lookups, specify `all` to include all matching tokens Default - `top` returns top-ranked tokens (by market cap or volume) + include_tokens: For `symbols` lookups, specify `all` to include all matching tokens. Default + `top` returns top-ranked tokens by market cap or volume. - names: coins' names, comma-separated if querying more than 1 coin. + names: Coins' names, comma-separated if querying more than 1 coin. - precision: decimal place for currency price value + precision: Decimal places for currency price value - symbols: coins' symbols, comma-separated if querying more than 1 coin. + symbols: Coins' symbols, comma-separated if querying more than 1 coin. extra_headers: Send extra headers @@ -212,33 +212,33 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> PriceGetResponse: """ - This endpoint allows you to **query the prices of one or more coins by using - their unique Coin API IDs, symbols, or names** + To query the prices of one or more coins by using their unique Coin API IDs, + symbols, or names Args: - vs_currencies: target currency of coins, comma-separated if querying more than 1 currency. + vs_currencies: Target currency of coins, comma-separated if querying more than 1 currency. \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) - ids: coins' IDs, comma-separated if querying more than 1 coin. \\**refers to - [`/coins/list`](/reference/coins-list). + ids: Coins' IDs, comma-separated if querying more than 1 coin. \\**refers to + [`/coins/list`](/reference/coins-list) - include_24hr_change: include 24hr change percentage, default: false + include_24hr_change: Include 24-hour change percentage. Default: false - include_24hr_vol: include 24hr volume, default: false + include_24hr_vol: Include 24-hour trading volume. Default: false - include_last_updated_at: include last updated price time in UNIX, default: false + include_last_updated_at: Include last updated price time as a UNIX timestamp. Default: false - include_market_cap: include market capitalization, default: false + include_market_cap: Include market capitalization. Default: false - include_tokens: for `symbols` lookups, specify `all` to include all matching tokens Default - `top` returns top-ranked tokens (by market cap or volume) + include_tokens: For `symbols` lookups, specify `all` to include all matching tokens. Default + `top` returns top-ranked tokens by market cap or volume. - names: coins' names, comma-separated if querying more than 1 coin. + names: Coins' names, comma-separated if querying more than 1 coin. - precision: decimal place for currency price value + precision: Decimal places for currency price value - symbols: coins' symbols, comma-separated if querying more than 1 coin. + symbols: Coins' symbols, comma-separated if querying more than 1 coin. extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/simple/supported_vs_currencies.py b/src/coingecko_sdk/resources/simple/supported_vs_currencies.py index 7f8fa21..831a4dd 100644 --- a/src/coingecko_sdk/resources/simple/supported_vs_currencies.py +++ b/src/coingecko_sdk/resources/simple/supported_vs_currencies.py @@ -49,7 +49,7 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> SupportedVsCurrencyGetResponse: - """This endpoint allows you to **query all the supported currencies on CoinGecko**""" + """To query all the supported currencies on CoinGecko""" return self._get( "/simple/supported_vs_currencies", options=make_request_options( @@ -89,7 +89,7 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> SupportedVsCurrencyGetResponse: - """This endpoint allows you to **query all the supported currencies on CoinGecko**""" + """To query all the supported currencies on CoinGecko""" return await self._get( "/simple/supported_vs_currencies", options=make_request_options( diff --git a/src/coingecko_sdk/resources/simple/token_price.py b/src/coingecko_sdk/resources/simple/token_price.py index 0bfc8f5..7d51a7d 100644 --- a/src/coingecko_sdk/resources/simple/token_price.py +++ b/src/coingecko_sdk/resources/simple/token_price.py @@ -84,26 +84,24 @@ def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TokenPriceGetIDResponse: """ - This endpoint allows you to **query one or more token prices using their token - contract addresses** + To query one or more token prices by using their token contract addresses Args: - contract_addresses: the contract addresses of tokens, comma-separated if querying more than 1 - token's contract address + contract_addresses: Token contract addresses, comma-separated if querying more than 1 token - vs_currencies: target currency of coins, comma-separated if querying more than 1 currency. + vs_currencies: Target currency of coins, comma-separated if querying more than 1 currency. \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) - include_24hr_change: include 24hr change default: false + include_24hr_change: Include 24-hour change percentage. Default: false - include_24hr_vol: include 24hr volume, default: false + include_24hr_vol: Include 24-hour trading volume. Default: false - include_last_updated_at: include last updated price time in UNIX , default: false + include_last_updated_at: Include last updated price time as a UNIX timestamp. Default: false - include_market_cap: include market capitalization, default: false + include_market_cap: Include market capitalization. Default: false - precision: decimal place for currency price value + precision: Decimal places for currency price value extra_headers: Send extra headers @@ -200,26 +198,24 @@ async def get_id( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TokenPriceGetIDResponse: """ - This endpoint allows you to **query one or more token prices using their token - contract addresses** + To query one or more token prices by using their token contract addresses Args: - contract_addresses: the contract addresses of tokens, comma-separated if querying more than 1 - token's contract address + contract_addresses: Token contract addresses, comma-separated if querying more than 1 token - vs_currencies: target currency of coins, comma-separated if querying more than 1 currency. + vs_currencies: Target currency of coins, comma-separated if querying more than 1 currency. \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) - include_24hr_change: include 24hr change default: false + include_24hr_change: Include 24-hour change percentage. Default: false - include_24hr_vol: include 24hr volume, default: false + include_24hr_vol: Include 24-hour trading volume. Default: false - include_last_updated_at: include last updated price time in UNIX , default: false + include_last_updated_at: Include last updated price time as a UNIX timestamp. Default: false - include_market_cap: include market capitalization, default: false + include_market_cap: Include market capitalization. Default: false - precision: decimal place for currency price value + precision: Decimal places for currency price value extra_headers: Send extra headers diff --git a/src/coingecko_sdk/resources/token_lists.py b/src/coingecko_sdk/resources/token_lists.py index 9729056..b363db3 100644 --- a/src/coingecko_sdk/resources/token_lists.py +++ b/src/coingecko_sdk/resources/token_lists.py @@ -52,9 +52,8 @@ def get_all_json( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TokenListGetAllJsonResponse: """ - This endpoint allows you to **get full list of tokens of a blockchain network - (asset platform) that is supported by - [Ethereum token list standard](https://tokenlists.org/)** + To get full list of tokens of a blockchain network (asset platform) that is + supported by [Ethereum token list standard](https://tokenlists.org/) Args: extra_headers: Send extra headers @@ -108,9 +107,8 @@ async def get_all_json( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> TokenListGetAllJsonResponse: """ - This endpoint allows you to **get full list of tokens of a blockchain network - (asset platform) that is supported by - [Ethereum token list standard](https://tokenlists.org/)** + To get full list of tokens of a blockchain network (asset platform) that is + supported by [Ethereum token list standard](https://tokenlists.org/) Args: extra_headers: Send extra headers diff --git a/src/coingecko_sdk/types/__init__.py b/src/coingecko_sdk/types/__init__.py index 7e0688d..cdbf50d 100644 --- a/src/coingecko_sdk/types/__init__.py +++ b/src/coingecko_sdk/types/__init__.py @@ -3,7 +3,6 @@ from __future__ import annotations from .news_get_params import NewsGetParams as NewsGetParams -from .treasury_entity import TreasuryEntity as TreasuryEntity from .key_get_response import KeyGetResponse as KeyGetResponse from .news_get_response import NewsGetResponse as NewsGetResponse from .ping_get_response import PingGetResponse as PingGetResponse @@ -15,7 +14,6 @@ from .nft_get_list_params import NFTGetListParams as NFTGetListParams from .search_get_response import SearchGetResponse as SearchGetResponse from .coin_get_id_response import CoinGetIDResponse as CoinGetIDResponse -from .detail_platform_data import DetailPlatformData as DetailPlatformData from .exchange_get_response import ExchangeGetResponse as ExchangeGetResponse from .nft_get_list_response import NFTGetListResponse as NFTGetListResponse from .entity_get_list_params import EntityGetListParams as EntityGetListParams diff --git a/src/coingecko_sdk/types/asset_platform_get_params.py b/src/coingecko_sdk/types/asset_platform_get_params.py index 4cf181d..f018e91 100644 --- a/src/coingecko_sdk/types/asset_platform_get_params.py +++ b/src/coingecko_sdk/types/asset_platform_get_params.py @@ -9,4 +9,4 @@ class AssetPlatformGetParams(TypedDict, total=False): filter: Literal["nft"] - """apply relevant filters to results""" + """Apply relevant filters to results.""" diff --git a/src/coingecko_sdk/types/asset_platform_get_response.py b/src/coingecko_sdk/types/asset_platform_get_response.py index 6ecdafd..c682ac1 100644 --- a/src/coingecko_sdk/types/asset_platform_get_response.py +++ b/src/coingecko_sdk/types/asset_platform_get_response.py @@ -9,33 +9,36 @@ class AssetPlatformGetResponseItemImage(BaseModel): - """image of the asset platform""" + """Asset platform image URLs""" large: Optional[str] = None + """Large image URL""" small: Optional[str] = None + """Small image URL""" thumb: Optional[str] = None + """Thumbnail image URL""" class AssetPlatformGetResponseItem(BaseModel): - id: Optional[str] = None - """asset platform ID""" + id: str + """Asset platform ID""" chain_identifier: Optional[float] = None - """chainlist's chain ID""" + """Chainlist's chain ID""" - image: Optional[AssetPlatformGetResponseItemImage] = None - """image of the asset platform""" + image: AssetPlatformGetResponseItemImage + """Asset platform image URLs""" - name: Optional[str] = None - """chain name""" + name: str + """Chain name""" native_coin_id: Optional[str] = None - """chain native coin ID""" + """Chain native coin ID""" - shortname: Optional[str] = None - """chain shortname""" + shortname: str + """Chain shortname""" AssetPlatformGetResponse: TypeAlias = List[AssetPlatformGetResponseItem] diff --git a/src/coingecko_sdk/types/coin_get_id_params.py b/src/coingecko_sdk/types/coin_get_id_params.py index c130e52..1047933 100644 --- a/src/coingecko_sdk/types/coin_get_id_params.py +++ b/src/coingecko_sdk/types/coin_get_id_params.py @@ -9,28 +9,28 @@ class CoinGetIDParams(TypedDict, total=False): community_data: bool - """include community data, default: true""" + """Include community data. Default: true""" developer_data: bool - """include developer data, default: true""" + """Include developer data. Default: true""" dex_pair_format: Literal["contract_address", "symbol"] - """ - set to `symbol` to display DEX pair base and target as symbols, default: - `contract_address` + """Set to `symbol` to display DEX pair base and target as symbols. + + Default: `contract_address` """ include_categories_details: bool - """include categories details, default: false""" + """Include categories details. Default: false""" localization: bool - """include all the localized languages in the response, default: true""" + """Include all localized languages in the response. Default: true""" market_data: bool - """include market data, default: true""" + """Include market data. Default: true""" sparkline: bool - """include sparkline 7 days data, default: false""" + """Include sparkline 7-day data. Default: false""" tickers: bool - """include tickers data, default: true""" + """Include tickers data. Default: true""" diff --git a/src/coingecko_sdk/types/coin_get_id_response.py b/src/coingecko_sdk/types/coin_get_id_response.py index 75999b8..0803f85 100644 --- a/src/coingecko_sdk/types/coin_get_id_response.py +++ b/src/coingecko_sdk/types/coin_get_id_response.py @@ -1,44 +1,23 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. from typing import Dict, List, Optional -from datetime import datetime from .._models import BaseModel -from .detail_platform_data import DetailPlatformData __all__ = [ "CoinGetIDResponse", + "DetailPlatforms", + "Image", + "Links", + "LinksReposURL", + "StatusUpdate", "CategoriesDetail", "CommunityData", "DeveloperData", "DeveloperDataCodeAdditionsDeletions4Weeks", "IcoData", - "Image", - "Links", - "LinksReposURL", "MarketData", - "MarketDataAth", - "MarketDataAthChangePercentage", - "MarketDataAthDate", - "MarketDataAtl", - "MarketDataAtlChangePercentage", - "MarketDataAtlDate", - "MarketDataCurrentPrice", - "MarketDataFullyDilutedValuation", - "MarketDataHigh24h", - "MarketDataLow24h", - "MarketDataMarketCap", - "MarketDataMarketCapChange24hInCurrency", - "MarketDataMarketCapChangePercentage24hInCurrency", - "MarketDataPriceChangePercentage14dInCurrency", - "MarketDataPriceChangePercentage1hInCurrency", - "MarketDataPriceChangePercentage1yInCurrency", - "MarketDataPriceChangePercentage200dInCurrency", - "MarketDataPriceChangePercentage24hInCurrency", - "MarketDataPriceChangePercentage30dInCurrency", - "MarketDataPriceChangePercentage60dInCurrency", - "MarketDataPriceChangePercentage7dInCurrency", - "MarketDataTotalVolume", + "MarketDataRoi", "Ticker", "TickerConvertedLast", "TickerConvertedVolume", @@ -46,38 +25,126 @@ ] +class DetailPlatforms(BaseModel): + contract_address: Optional[str] = None + """Token contract address""" + + decimal_place: Optional[int] = None + """Token decimal place""" + + +class Image(BaseModel): + """Coin image URL""" + + large: Optional[str] = None + + small: Optional[str] = None + + thumb: Optional[str] = None + + +class LinksReposURL(BaseModel): + """Repository URL""" + + bitbucket: Optional[List[str]] = None + """Bitbucket repository URL""" + + github: Optional[List[str]] = None + """GitHub repository URL""" + + +class Links(BaseModel): + """Links""" + + announcement_url: Optional[List[str]] = None + """Announcement URL""" + + bitcointalk_thread_identifier: Optional[int] = None + """Bitcointalk thread identifier""" + + blockchain_site: Optional[List[str]] = None + """Block explorer URL""" + + chat_url: Optional[List[str]] = None + """Chat URL""" + + facebook_username: Optional[str] = None + """Facebook username""" + + homepage: Optional[List[str]] = None + """Website URL""" + + official_forum_url: Optional[List[str]] = None + """Official forum URL""" + + repos_url: Optional[LinksReposURL] = None + """Repository URL""" + + snapshot_url: Optional[str] = None + """Snapshot URL""" + + subreddit_url: Optional[str] = None + """Subreddit URL""" + + telegram_channel_identifier: Optional[str] = None + """Telegram channel identifier""" + + twitter_screen_name: Optional[str] = None + """Twitter handle""" + + whitepaper: Optional[str] = None + """Whitepaper URL""" + + +class StatusUpdate(BaseModel): + category: Optional[str] = None + """Status update category""" + + created_at: Optional[str] = None + """Status update creation time""" + + description: Optional[str] = None + """Status update description""" + + user: Optional[str] = None + """Status update user""" + + user_title: Optional[str] = None + """Status update user title""" + + class CategoriesDetail(BaseModel): id: Optional[str] = None - """category ID""" + """Category ID""" name: Optional[str] = None - """category name""" + """Category name""" class CommunityData(BaseModel): - """coin community data""" + """Community data""" facebook_likes: Optional[float] = None - """coin facebook likes""" + """Facebook likes""" reddit_accounts_active_48h: Optional[float] = None - """coin reddit active accounts in 48 hours""" + """Reddit active accounts in 48 hours""" reddit_average_comments_48h: Optional[float] = None - """coin reddit average comments in 48 hours""" + """Reddit average comments in 48 hours""" reddit_average_posts_48h: Optional[float] = None - """coin reddit average posts in 48 hours""" + """Reddit average posts in 48 hours""" reddit_subscribers: Optional[float] = None - """coin reddit subscribers""" + """Reddit subscribers""" telegram_channel_user_count: Optional[float] = None - """coin telegram channel user count""" + """Telegram channel user count""" class DeveloperDataCodeAdditionsDeletions4Weeks(BaseModel): - """coin code additions and deletions in 4 weeks""" + """Code additions and deletions in 4 weeks""" additions: Optional[float] = None @@ -85,73 +152,73 @@ class DeveloperDataCodeAdditionsDeletions4Weeks(BaseModel): class DeveloperData(BaseModel): - """coin developer data""" + """Developer data""" closed_issues: Optional[float] = None - """coin repository closed issues""" + """Repository closed issues""" code_additions_deletions_4_weeks: Optional[DeveloperDataCodeAdditionsDeletions4Weeks] = None - """coin code additions and deletions in 4 weeks""" + """Code additions and deletions in 4 weeks""" commit_count_4_weeks: Optional[float] = None - """coin repository commit count in 4 weeks""" + """Repository commit count in 4 weeks""" forks: Optional[float] = None - """coin repository forks""" + """Repository forks""" last_4_weeks_commit_activity_series: Optional[List[float]] = None - """coin repository last 4 weeks commit activity series""" + """Repository last 4 weeks commit activity series""" pull_request_contributors: Optional[float] = None - """coin repository pull request contributors""" + """Repository pull request contributors""" pull_requests_merged: Optional[float] = None - """coin repository pull requests merged""" + """Repository pull requests merged""" stars: Optional[float] = None - """coin repository stars""" + """Repository stars""" subscribers: Optional[float] = None - """coin repository subscribers""" + """Repository subscribers""" total_issues: Optional[float] = None - """coin repository total issues""" + """Repository total issues""" class IcoData(BaseModel): - """coin ICO data""" + """ICO data""" accepting_currencies: Optional[str] = None - """accepting currencies""" + """Accepting currencies""" amount_for_sale: Optional[float] = None - """amount for sale""" + """Amount for sale""" base_pre_sale_amount: Optional[float] = None - """base pre-sale amount""" + """Base pre-sale amount""" base_public_sale_amount: Optional[float] = None - """base public sale amount""" + """Base public sale amount""" bounty_detail_url: Optional[str] = None - """bounty detail url""" + """Bounty detail URL""" country_origin: Optional[str] = None - """country of origin""" + """Country of origin""" description: Optional[str] = None - """detailed description""" + """Detailed description""" hardcap_amount: Optional[float] = None - """hardcap amount""" + """Hardcap amount""" hardcap_currency: Optional[str] = None - """hardcap currency""" + """Hardcap currency""" - ico_end_date: Optional[datetime] = None + ico_end_date: Optional[str] = None """ICO end date""" - ico_start_date: Optional[datetime] = None + ico_start_date: Optional[str] = None """ICO start date""" kyc_required: Optional[bool] = None @@ -161,483 +228,220 @@ class IcoData(BaseModel): """ICO related links""" pre_sale_available: Optional[bool] = None - """pre-sale available""" + """Pre-sale available""" - pre_sale_end_date: Optional[datetime] = None - """pre-sale end date""" + pre_sale_end_date: Optional[str] = None + """Pre-sale end date""" pre_sale_ended: Optional[bool] = None - """pre-sale ended""" + """Pre-sale ended""" - pre_sale_start_date: Optional[datetime] = None - """pre-sale start date""" + pre_sale_start_date: Optional[str] = None + """Pre-sale start date""" quote_pre_sale_amount: Optional[float] = None - """quote pre-sale amount""" + """Quote pre-sale amount""" quote_pre_sale_currency: Optional[str] = None - """quote pre-sale currency""" + """Quote pre-sale currency""" quote_public_sale_amount: Optional[float] = None - """quote public sale amount""" + """Quote public sale amount""" quote_public_sale_currency: Optional[str] = None - """quote public sale currency""" + """Quote public sale currency""" short_desc: Optional[str] = None - """short description""" + """Short description""" softcap_amount: Optional[float] = None - """softcap amount""" + """Softcap amount""" softcap_currency: Optional[str] = None - """softcap currency""" + """Softcap currency""" total_raised: Optional[float] = None - """total raised amount""" + """Total raised amount""" total_raised_currency: Optional[str] = None - """total raised currency""" + """Total raised currency""" whitelist_available: Optional[bool] = None - """whitelist available""" + """Whitelist available""" - whitelist_end_date: Optional[datetime] = None - """whitelist end date""" + whitelist_end_date: Optional[str] = None + """Whitelist end date""" - whitelist_start_date: Optional[datetime] = None - """whitelist start date""" + whitelist_start_date: Optional[str] = None + """Whitelist start date""" whitelist_url: Optional[str] = None - """whitelist url""" - - -class Image(BaseModel): - """coin image url""" - - large: Optional[str] = None - - small: Optional[str] = None - - thumb: Optional[str] = None - + """Whitelist URL""" -class LinksReposURL(BaseModel): - """coin repository url""" - - bitbucket: Optional[List[str]] = None - """coin bitbucket repository url""" - - github: Optional[List[str]] = None - """coin github repository url""" - - -class Links(BaseModel): - """links""" - - announcement_url: Optional[List[str]] = None - """coin announcement url""" - bitcointalk_thread_identifier: Optional[str] = None - """coin bitcointalk thread identifier""" +class MarketDataRoi(BaseModel): + """Return on investment""" - blockchain_site: Optional[List[str]] = None - """coin block explorer url""" + currency: Optional[str] = None + """ROI currency""" - chat_url: Optional[List[str]] = None - """coin chat url""" - - facebook_username: Optional[str] = None - """coin facebook username""" - - homepage: Optional[List[str]] = None - """coin website url""" - - official_forum_url: Optional[List[str]] = None - """coin official forum url""" + percentage: Optional[float] = None + """ROI percentage""" - repos_url: Optional[LinksReposURL] = None - """coin repository url""" - - snapshot_url: Optional[str] = None - """coin snapshot url""" - - subreddit_url: Optional[str] = None - """coin subreddit url""" - - telegram_channel_identifier: Optional[str] = None - """coin telegram channel identifier""" - - twitter_screen_name: Optional[str] = None - """coin twitter handle""" - - whitepaper: Optional[List[str]] = None - """coin whitepaper url""" - - -class MarketDataAth(BaseModel): - """coin all time high (ATH) in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataAthChangePercentage(BaseModel): - """coin all time high (ATH) change in percentage""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataAthDate(BaseModel): - """coin all time high (ATH) date""" - - btc: Optional[str] = None - - eur: Optional[str] = None - - usd: Optional[str] = None - - -class MarketDataAtl(BaseModel): - """coin all time low (atl) in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataAtlChangePercentage(BaseModel): - """coin all time low (atl) change in percentage""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataAtlDate(BaseModel): - """coin all time low (atl) date""" - - btc: Optional[str] = None - - eur: Optional[str] = None - - usd: Optional[str] = None - - -class MarketDataCurrentPrice(BaseModel): - """coin current price in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataFullyDilutedValuation(BaseModel): - """coin fully diluted valuation (fdv) in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataHigh24h(BaseModel): - """coin 24hr price high in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataLow24h(BaseModel): - """coin 24hr price low in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataMarketCap(BaseModel): - """coin market cap in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataMarketCapChange24hInCurrency(BaseModel): - """coin 24hr market cap change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataMarketCapChangePercentage24hInCurrency(BaseModel): - """coin 24hr market cap change in percentage""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage14dInCurrency(BaseModel): - """coin 14d price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage1hInCurrency(BaseModel): - """coin 1h price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage1yInCurrency(BaseModel): - """coin 1y price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage200dInCurrency(BaseModel): - """coin 200d price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage24hInCurrency(BaseModel): - """coin 24hr price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage30dInCurrency(BaseModel): - """coin 30d price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage60dInCurrency(BaseModel): - """coin 60d price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage7dInCurrency(BaseModel): - """coin 7d price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataTotalVolume(BaseModel): - """coin total trading volume in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None + times: Optional[float] = None + """ROI multiplier""" class MarketData(BaseModel): - """coin market data""" + """Market data""" - ath: Optional[MarketDataAth] = None - """coin all time high (ATH) in currency""" + ath: Optional[Dict[str, float]] = None + """All-time high in target currency""" - ath_change_percentage: Optional[MarketDataAthChangePercentage] = None - """coin all time high (ATH) change in percentage""" + ath_change_percentage: Optional[Dict[str, float]] = None + """All-time high change percentage""" - ath_date: Optional[MarketDataAthDate] = None - """coin all time high (ATH) date""" + ath_date: Optional[Dict[str, str]] = None + """All-time high date""" - atl: Optional[MarketDataAtl] = None - """coin all time low (atl) in currency""" + atl: Optional[Dict[str, float]] = None + """All-time low in target currency""" - atl_change_percentage: Optional[MarketDataAtlChangePercentage] = None - """coin all time low (atl) change in percentage""" + atl_change_percentage: Optional[Dict[str, float]] = None + """All-time low change percentage""" - atl_date: Optional[MarketDataAtlDate] = None - """coin all time low (atl) date""" + atl_date: Optional[Dict[str, str]] = None + """All-time low date""" circulating_supply: Optional[float] = None - """coin circulating supply""" + """Circulating supply""" - current_price: Optional[MarketDataCurrentPrice] = None - """coin current price in currency""" + current_price: Optional[Dict[str, float]] = None + """Current price in target currency""" fdv_to_tvl_ratio: Optional[float] = None - """fully diluted valuation to total value locked ratio""" + """FDV to TVL ratio""" - fully_diluted_valuation: Optional[MarketDataFullyDilutedValuation] = None - """coin fully diluted valuation (fdv) in currency""" + fully_diluted_valuation: Optional[Dict[str, float]] = None + """Fully diluted valuation in target currency""" - high_24h: Optional[MarketDataHigh24h] = None - """coin 24hr price high in currency""" + high_24h: Optional[Dict[str, float]] = None + """24h price high in target currency""" - last_updated: Optional[datetime] = None - """coin market data last updated timestamp""" + last_updated: Optional[str] = None + """Market data last updated timestamp""" - low_24h: Optional[MarketDataLow24h] = None - """coin 24hr price low in currency""" + low_24h: Optional[Dict[str, float]] = None + """24h price low in target currency""" - market_cap: Optional[MarketDataMarketCap] = None - """coin market cap in currency""" + market_cap: Optional[Dict[str, float]] = None + """Market cap in target currency""" market_cap_change_24h: Optional[float] = None - """coin 24hr market cap change in currency""" + """24h market cap change in target currency""" - market_cap_change_24h_in_currency: Optional[MarketDataMarketCapChange24hInCurrency] = None - """coin 24hr market cap change in currency""" + market_cap_change_24h_in_currency: Optional[Dict[str, float]] = None + """24h market cap change in target currency""" market_cap_change_percentage_24h: Optional[float] = None - """coin 24hr market cap change in percentage""" + """24h market cap change percentage""" - market_cap_change_percentage_24h_in_currency: Optional[MarketDataMarketCapChangePercentage24hInCurrency] = None - """coin 24hr market cap change in percentage""" + market_cap_change_percentage_24h_in_currency: Optional[Dict[str, float]] = None + """24h market cap change percentage per currency""" market_cap_fdv_ratio: Optional[float] = None - """market cap to fully diluted valuation ratio""" + """Market cap to FDV ratio""" - market_cap_rank: Optional[float] = None - """coin rank by market cap""" + market_cap_rank: Optional[int] = None + """Market cap rank""" - market_cap_rank_with_rehypothecated: Optional[float] = None - """coin rank by market cap including rehypothecated tokens""" + market_cap_rank_with_rehypothecated: Optional[int] = None + """Market cap rank including rehypothecated tokens""" max_supply: Optional[float] = None - """coin max supply""" + """Max supply""" + + max_supply_infinite: Optional[bool] = None + """Max supply infinite""" mcap_to_tvl_ratio: Optional[float] = None - """market cap to total value locked ratio""" + """Market cap to TVL ratio""" outstanding_supply: Optional[float] = None - """ - tokens outstanding in the market, circulated/tradable or planned for circulation - """ + """Tokens outstanding in the market""" outstanding_token_value_usd: Optional[float] = None - """outstanding token value in USD""" + """Outstanding token value in USD""" price_change_24h: Optional[float] = None - """coin 24hr price change in currency""" + """24h price change in target currency""" + + price_change_24h_in_currency: Optional[Dict[str, float]] = None + """24h price change in target currency""" price_change_percentage_14d: Optional[float] = None - """coin 14d price change in percentage""" + """14d price change percentage""" - price_change_percentage_14d_in_currency: Optional[MarketDataPriceChangePercentage14dInCurrency] = None - """coin 14d price change in currency""" + price_change_percentage_14d_in_currency: Optional[Dict[str, float]] = None + """14d price change percentage per currency""" - price_change_percentage_1h_in_currency: Optional[MarketDataPriceChangePercentage1hInCurrency] = None - """coin 1h price change in currency""" + price_change_percentage_1h_in_currency: Optional[Dict[str, float]] = None + """1h price change percentage per currency""" price_change_percentage_1y: Optional[float] = None - """coin 1y price change in percentage""" + """1y price change percentage""" - price_change_percentage_1y_in_currency: Optional[MarketDataPriceChangePercentage1yInCurrency] = None - """coin 1y price change in currency""" + price_change_percentage_1y_in_currency: Optional[Dict[str, float]] = None + """1y price change percentage per currency""" price_change_percentage_200d: Optional[float] = None - """coin 200d price change in percentage""" + """200d price change percentage""" - price_change_percentage_200d_in_currency: Optional[MarketDataPriceChangePercentage200dInCurrency] = None - """coin 200d price change in currency""" + price_change_percentage_200d_in_currency: Optional[Dict[str, float]] = None + """200d price change percentage per currency""" price_change_percentage_24h: Optional[float] = None - """coin 24hr price change in percentage""" + """24h price change percentage""" - price_change_percentage_24h_in_currency: Optional[MarketDataPriceChangePercentage24hInCurrency] = None - """coin 24hr price change in currency""" + price_change_percentage_24h_in_currency: Optional[Dict[str, float]] = None + """24h price change percentage per currency""" price_change_percentage_30d: Optional[float] = None - """coin 30d price change in percentage""" + """30d price change percentage""" - price_change_percentage_30d_in_currency: Optional[MarketDataPriceChangePercentage30dInCurrency] = None - """coin 30d price change in currency""" + price_change_percentage_30d_in_currency: Optional[Dict[str, float]] = None + """30d price change percentage per currency""" price_change_percentage_60d: Optional[float] = None - """coin 60d price change in percentage""" + """60d price change percentage""" - price_change_percentage_60d_in_currency: Optional[MarketDataPriceChangePercentage60dInCurrency] = None - """coin 60d price change in currency""" + price_change_percentage_60d_in_currency: Optional[Dict[str, float]] = None + """60d price change percentage per currency""" price_change_percentage_7d: Optional[float] = None - """coin 7d price change in percentage""" + """7d price change percentage""" + + price_change_percentage_7d_in_currency: Optional[Dict[str, float]] = None + """7d price change percentage per currency""" - price_change_percentage_7d_in_currency: Optional[MarketDataPriceChangePercentage7dInCurrency] = None - """coin 7d price change in currency""" + roi: Optional[MarketDataRoi] = None + """Return on investment""" - roi: Optional[float] = None - """coin return on investment""" + sparkline_7d: Optional[List[float]] = None + """Sparkline 7-day price data""" total_supply: Optional[float] = None - """coin total supply""" + """Total supply""" total_value_locked: Optional[float] = None - """total value locked""" + """Total value locked""" - total_volume: Optional[MarketDataTotalVolume] = None - """coin total trading volume in currency""" + total_volume: Optional[Dict[str, float]] = None + """Total trading volume in target currency""" class TickerConvertedLast(BaseModel): - """coin ticker converted last price""" + """Ticker converted last price""" btc: Optional[float] = None @@ -647,7 +451,7 @@ class TickerConvertedLast(BaseModel): class TickerConvertedVolume(BaseModel): - """coin ticker converted volume""" + """Ticker converted volume""" btc: Optional[float] = None @@ -657,170 +461,170 @@ class TickerConvertedVolume(BaseModel): class TickerMarket(BaseModel): - """coin ticker exchange""" + """Ticker exchange""" has_trading_incentive: Optional[bool] = None - """coin ticker exchange trading incentive""" + """Exchange trading incentive""" identifier: Optional[str] = None - """coin ticker exchange identifier""" + """Exchange identifier""" name: Optional[str] = None - """coin ticker exchange name""" + """Exchange name""" class Ticker(BaseModel): base: Optional[str] = None - """coin ticker base currency""" + """Ticker base currency""" bid_ask_spread_percentage: Optional[float] = None - """coin ticker bid ask spread percentage""" + """Ticker bid-ask spread percentage""" coin_id: Optional[str] = None - """coin ticker base currency coin ID""" + """Ticker base currency coin ID""" coin_mcap_usd: Optional[float] = None - """coin market cap in usd""" + """Market cap in USD""" converted_last: Optional[TickerConvertedLast] = None - """coin ticker converted last price""" + """Ticker converted last price""" converted_volume: Optional[TickerConvertedVolume] = None - """coin ticker converted volume""" + """Ticker converted volume""" is_anomaly: Optional[bool] = None - """coin ticker anomaly""" + """Ticker anomaly""" is_stale: Optional[bool] = None - """coin ticker stale""" + """Ticker stale""" last: Optional[float] = None - """coin ticker last price""" + """Ticker last price""" - last_fetch_at: Optional[datetime] = None - """coin ticker last fetch timestamp""" + last_fetch_at: Optional[str] = None + """Ticker last fetch timestamp""" - last_traded_at: Optional[datetime] = None - """coin ticker last traded timestamp""" + last_traded_at: Optional[str] = None + """Ticker last traded timestamp""" market: Optional[TickerMarket] = None - """coin ticker exchange""" + """Ticker exchange""" target: Optional[str] = None - """coin ticker target currency""" + """Ticker target currency""" target_coin_id: Optional[str] = None - """coin ticker target currency coin ID""" + """Ticker target currency coin ID""" - timestamp: Optional[datetime] = None - """coin ticker timestamp""" + timestamp: Optional[str] = None + """Ticker timestamp""" token_info_url: Optional[str] = None - """coin ticker token info url""" + """Ticker token info URL""" trade_url: Optional[str] = None - """coin ticker trade url""" + """Ticker trade URL""" trust_score: Optional[str] = None - """coin ticker trust score""" + """Ticker trust score""" volume: Optional[float] = None - """coin ticker volume""" + """Ticker volume""" class CoinGetIDResponse(BaseModel): - id: Optional[str] = None - """coin ID""" + id: str + """Coin ID""" - additional_notices: Optional[List[str]] = None - """additional notices""" + additional_notices: List[str] + """Additional notices""" asset_platform_id: Optional[str] = None - """coin asset platform ID""" + """Coin asset platform ID""" - block_time_in_minutes: Optional[float] = None - """blockchain block time in minutes""" + block_time_in_minutes: float + """Blockchain block time in minutes""" - categories: Optional[List[str]] = None - """coin categories""" + categories: List[str] + """Coin categories""" - categories_details: Optional[List[CategoriesDetail]] = None - """detailed coin categories""" + country_origin: str + """Country of origin""" - community_data: Optional[CommunityData] = None - """coin community data""" + description: Dict[str, str] + """Coin description""" - country_origin: Optional[str] = None - """coin country of origin""" + detail_platforms: Dict[str, DetailPlatforms] + """Detailed coin asset platform and contract address""" - description: Optional[Dict[str, str]] = None - """coin description""" + genesis_date: Optional[str] = None + """Genesis date""" - detail_platforms: Optional[Dict[str, DetailPlatformData]] = None - """detailed coin asset platform and contract address""" + hashing_algorithm: Optional[str] = None + """Blockchain hashing algorithm""" - developer_data: Optional[DeveloperData] = None - """coin developer data""" + image: Image + """Coin image URL""" - genesis_date: Optional[datetime] = None - """coin genesis date""" + last_updated: str + """Last updated timestamp""" - hashing_algorithm: Optional[str] = None - """blockchain hashing algorithm""" + links: Links + """Links""" - ico_data: Optional[IcoData] = None - """coin ICO data""" + market_cap_rank: Optional[int] = None + """Market cap rank""" - image: Optional[Image] = None - """coin image url""" + market_cap_rank_with_rehypothecated: Optional[int] = None + """Market cap rank including rehypothecated tokens""" - last_updated: Optional[datetime] = None - """coin last updated timestamp""" + name: str + """Coin name""" - links: Optional[Links] = None - """links""" + platforms: Dict[str, str] + """Coin asset platform and contract address""" - localization: Optional[Dict[str, str]] = None - """coin name localization""" + preview_listing: bool + """Preview listing coin""" - market_cap_rank: Optional[float] = None - """coin rank by market cap""" + public_notice: Optional[str] = None + """Public notice""" - market_cap_rank_with_rehypothecated: Optional[float] = None - """coin rank by market cap including rehypothecated tokens""" + sentiment_votes_down_percentage: Optional[float] = None + """Sentiment votes down percentage""" - market_data: Optional[MarketData] = None - """coin market data""" + sentiment_votes_up_percentage: Optional[float] = None + """Sentiment votes up percentage""" - name: Optional[str] = None - """coin name""" + status_updates: List[StatusUpdate] + """Status updates""" - platforms: Optional[Dict[str, Optional[str]]] = None - """coin asset platform and contract address""" + symbol: str + """Coin symbol""" - preview_listing: Optional[bool] = None - """preview listing coin""" + watchlist_portfolio_users: float + """Number of users watching this coin in portfolio""" - public_notice: Optional[str] = None - """public notice""" + web_slug: str + """Coin web slug""" - sentiment_votes_down_percentage: Optional[float] = None - """coin sentiment votes down percentage""" + categories_details: Optional[List[CategoriesDetail]] = None + """Detailed coin categories""" - sentiment_votes_up_percentage: Optional[float] = None - """coin sentiment votes up percentage""" + community_data: Optional[CommunityData] = None + """Community data""" - status_updates: Optional[List[str]] = None - """coin status updates""" + developer_data: Optional[DeveloperData] = None + """Developer data""" - symbol: Optional[str] = None - """coin symbol""" + ico_data: Optional[IcoData] = None + """ICO data""" - tickers: Optional[List[Ticker]] = None - """coin tickers""" + localization: Optional[Dict[str, str]] = None + """Coin name localization""" - watchlist_portfolio_users: Optional[float] = None - """number of users watching this coin in portfolio""" + market_data: Optional[MarketData] = None + """Market data""" - web_slug: Optional[str] = None - """coin web slug""" + tickers: Optional[List[Ticker]] = None + """Tickers""" diff --git a/src/coingecko_sdk/types/coins/__init__.py b/src/coingecko_sdk/types/coins/__init__.py index e431dc7..d8df14a 100644 --- a/src/coingecko_sdk/types/coins/__init__.py +++ b/src/coingecko_sdk/types/coins/__init__.py @@ -19,6 +19,7 @@ from .ohlc_get_range_params import OhlcGetRangeParams as OhlcGetRangeParams from .market_chart_get_params import MarketChartGetParams as MarketChartGetParams from .ohlc_get_range_response import OhlcGetRangeResponse as OhlcGetRangeResponse +from .top_gainers_losers_item import TopGainersLosersItem as TopGainersLosersItem from .market_chart_get_response import MarketChartGetResponse as MarketChartGetResponse from .category_get_list_response import CategoryGetListResponse as CategoryGetListResponse from .top_gainers_loser_get_params import TopGainersLoserGetParams as TopGainersLoserGetParams diff --git a/src/coingecko_sdk/types/coins/category_get_list_response.py b/src/coingecko_sdk/types/coins/category_get_list_response.py index 48c9d86..d7e5cd4 100644 --- a/src/coingecko_sdk/types/coins/category_get_list_response.py +++ b/src/coingecko_sdk/types/coins/category_get_list_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from typing_extensions import TypeAlias from ..._models import BaseModel @@ -9,11 +9,11 @@ class CategoryGetListResponseItem(BaseModel): - category_id: Optional[str] = None - """category ID""" + category_id: str + """Category ID""" - name: Optional[str] = None - """category name""" + name: str + """Category name""" CategoryGetListResponse: TypeAlias = List[CategoryGetListResponseItem] diff --git a/src/coingecko_sdk/types/coins/category_get_params.py b/src/coingecko_sdk/types/coins/category_get_params.py index 5b8e04d..56ce332 100644 --- a/src/coingecko_sdk/types/coins/category_get_params.py +++ b/src/coingecko_sdk/types/coins/category_get_params.py @@ -16,4 +16,4 @@ class CategoryGetParams(TypedDict, total=False): "market_cap_change_24h_desc", "market_cap_change_24h_asc", ] - """sort results by field, default: market_cap_desc""" + """Sort results by field. Default: `market_cap_desc`""" diff --git a/src/coingecko_sdk/types/coins/category_get_response.py b/src/coingecko_sdk/types/coins/category_get_response.py index 1d289dd..fc8e27e 100644 --- a/src/coingecko_sdk/types/coins/category_get_response.py +++ b/src/coingecko_sdk/types/coins/category_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from typing_extensions import TypeAlias from ..._models import BaseModel @@ -9,32 +9,32 @@ class CategoryGetResponseItem(BaseModel): - id: Optional[str] = None - """category ID""" + id: str + """Category ID""" - content: Optional[str] = None - """category description""" + content: str + """Category description""" - market_cap: Optional[float] = None - """category market cap""" + market_cap: float + """Category market cap""" - market_cap_change_24h: Optional[float] = None - """category market cap change in 24 hours""" + market_cap_change_24h: float + """Category market cap change in 24 hours""" - name: Optional[str] = None - """category name""" + name: str + """Category name""" - top_3_coins: Optional[List[str]] = None - """images of top 3 coins in the category""" + top_3_coins: List[str] + """Image URLs of top 3 coins in the category""" - top_3_coins_id: Optional[List[str]] = None + top_3_coins_id: List[str] """IDs of top 3 coins in the category""" - updated_at: Optional[str] = None - """category last updated time""" + updated_at: str + """Category last updated timestamp""" - volume_24h: Optional[float] = None - """category volume in 24 hours""" + volume_24h: float + """Category trading volume in 24 hours""" CategoryGetResponse: TypeAlias = List[CategoryGetResponseItem] diff --git a/src/coingecko_sdk/types/coins/circulating_supply_chart_get_params.py b/src/coingecko_sdk/types/coins/circulating_supply_chart_get_params.py index 6d4b677..bfad479 100644 --- a/src/coingecko_sdk/types/coins/circulating_supply_chart_get_params.py +++ b/src/coingecko_sdk/types/coins/circulating_supply_chart_get_params.py @@ -9,7 +9,7 @@ class CirculatingSupplyChartGetParams(TypedDict, total=False): days: Required[str] - """data up to number of days ago Valid values: any integer or `max`""" + """Data up to number of days ago. Valid values: any integer or `max`.""" interval: Literal["5m", "hourly", "daily"] - """data interval""" + """Data interval.""" diff --git a/src/coingecko_sdk/types/coins/circulating_supply_chart_get_range_params.py b/src/coingecko_sdk/types/coins/circulating_supply_chart_get_range_params.py index 1a4a088..f8efc3a 100644 --- a/src/coingecko_sdk/types/coins/circulating_supply_chart_get_range_params.py +++ b/src/coingecko_sdk/types/coins/circulating_supply_chart_get_range_params.py @@ -12,12 +12,12 @@ class CirculatingSupplyChartGetRangeParams(TypedDict, total=False): from_: Required[Annotated[str, PropertyInfo(alias="from")]] """ - starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ to: Required[str] """ - ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ diff --git a/src/coingecko_sdk/types/coins/circulating_supply_chart_get_range_response.py b/src/coingecko_sdk/types/coins/circulating_supply_chart_get_range_response.py index 7f73954..c99a9c6 100644 --- a/src/coingecko_sdk/types/coins/circulating_supply_chart_get_range_response.py +++ b/src/coingecko_sdk/types/coins/circulating_supply_chart_get_range_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Union, Optional +from typing import List, Union from ..._models import BaseModel @@ -8,4 +8,5 @@ class CirculatingSupplyChartGetRangeResponse(BaseModel): - circulating_supply: Optional[List[List[Union[float, str]]]] = None + circulating_supply: List[List[Union[float, str]]] + """Circulating supply data points as [timestamp, supply] pairs""" diff --git a/src/coingecko_sdk/types/coins/circulating_supply_chart_get_response.py b/src/coingecko_sdk/types/coins/circulating_supply_chart_get_response.py index d808b8f..8ff4a10 100644 --- a/src/coingecko_sdk/types/coins/circulating_supply_chart_get_response.py +++ b/src/coingecko_sdk/types/coins/circulating_supply_chart_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Union, Optional +from typing import List, Union from ..._models import BaseModel @@ -8,4 +8,5 @@ class CirculatingSupplyChartGetResponse(BaseModel): - circulating_supply: Optional[List[List[Union[float, str]]]] = None + circulating_supply: List[List[Union[float, str]]] + """Circulating supply data points as [timestamp, supply] pairs""" diff --git a/src/coingecko_sdk/types/coins/contract/market_chart_get_params.py b/src/coingecko_sdk/types/coins/contract/market_chart_get_params.py index e134a8d..bcd6865 100644 --- a/src/coingecko_sdk/types/coins/contract/market_chart_get_params.py +++ b/src/coingecko_sdk/types/coins/contract/market_chart_get_params.py @@ -11,21 +11,22 @@ class MarketChartGetParams(TypedDict, total=False): id: Required[str] days: Required[str] - """ - data up to number of days ago You may use any integer or `max` for number of - days + """Data up to number of days ago. + + You may use any integer or `max` for number of days. """ vs_currency: Required[str] - """ - target currency of market data \\**refers to + """Target currency of market data. + + \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). """ interval: Literal["5m", "hourly", "daily"] - """data interval, leave empty for auto granularity""" + """Data interval, leave empty for auto granularity.""" precision: Literal[ "full", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18" ] - """decimal place for currency price value""" + """Decimal place for currency price value.""" diff --git a/src/coingecko_sdk/types/coins/contract/market_chart_get_range_params.py b/src/coingecko_sdk/types/coins/contract/market_chart_get_range_params.py index 52492aa..ac6d49e 100644 --- a/src/coingecko_sdk/types/coins/contract/market_chart_get_range_params.py +++ b/src/coingecko_sdk/types/coins/contract/market_chart_get_range_params.py @@ -14,26 +14,27 @@ class MarketChartGetRangeParams(TypedDict, total=False): from_: Required[Annotated[str, PropertyInfo(alias="from")]] """ - starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ to: Required[str] """ - ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ vs_currency: Required[str] - """ - target currency of market data \\**refers to + """Target currency of market data. + + \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). """ interval: Literal["5m", "hourly", "daily"] - """data interval, leave empty for auto granularity""" + """Data interval, leave empty for auto granularity.""" precision: Literal[ "full", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18" ] - """decimal place for currency price value""" + """Decimal place for currency price value.""" diff --git a/src/coingecko_sdk/types/coins/contract/market_chart_get_range_response.py b/src/coingecko_sdk/types/coins/contract/market_chart_get_range_response.py index 8b444bb..9ce371e 100644 --- a/src/coingecko_sdk/types/coins/contract/market_chart_get_range_response.py +++ b/src/coingecko_sdk/types/coins/contract/market_chart_get_range_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ...._models import BaseModel @@ -8,8 +8,11 @@ class MarketChartGetRangeResponse(BaseModel): - market_caps: Optional[List[List[float]]] = None + market_caps: List[List[float]] + """Market cap data points as [timestamp, market_cap] pairs""" - prices: Optional[List[List[float]]] = None + prices: List[List[float]] + """Price data points as [timestamp, price] pairs""" - total_volumes: Optional[List[List[float]]] = None + total_volumes: List[List[float]] + """Total volume data points as [timestamp, volume] pairs""" diff --git a/src/coingecko_sdk/types/coins/contract/market_chart_get_response.py b/src/coingecko_sdk/types/coins/contract/market_chart_get_response.py index aa7d5bd..8d41a10 100644 --- a/src/coingecko_sdk/types/coins/contract/market_chart_get_response.py +++ b/src/coingecko_sdk/types/coins/contract/market_chart_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ...._models import BaseModel @@ -8,8 +8,11 @@ class MarketChartGetResponse(BaseModel): - market_caps: Optional[List[List[float]]] = None + market_caps: List[List[float]] + """Market cap data points as [timestamp, market_cap] pairs""" - prices: Optional[List[List[float]]] = None + prices: List[List[float]] + """Price data points as [timestamp, price] pairs""" - total_volumes: Optional[List[List[float]]] = None + total_volumes: List[List[float]] + """Total volume data points as [timestamp, volume] pairs""" diff --git a/src/coingecko_sdk/types/coins/contract_get_response.py b/src/coingecko_sdk/types/coins/contract_get_response.py index 2e857ae..cf173b1 100644 --- a/src/coingecko_sdk/types/coins/contract_get_response.py +++ b/src/coingecko_sdk/types/coins/contract_get_response.py @@ -1,42 +1,21 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. from typing import Dict, List, Optional -from datetime import datetime from ..._models import BaseModel -from ..detail_platform_data import DetailPlatformData __all__ = [ "ContractGetResponse", - "CommunityData", - "DeveloperData", - "DeveloperDataCodeAdditionsDeletions4Weeks", + "DetailPlatforms", "Image", "Links", "LinksReposURL", + "StatusUpdate", + "CommunityData", + "DeveloperData", + "DeveloperDataCodeAdditionsDeletions4Weeks", "MarketData", - "MarketDataAth", - "MarketDataAthChangePercentage", - "MarketDataAthDate", - "MarketDataAtl", - "MarketDataAtlChangePercentage", - "MarketDataAtlDate", - "MarketDataCurrentPrice", - "MarketDataFullyDilutedValuation", - "MarketDataHigh24h", - "MarketDataLow24h", - "MarketDataMarketCap", - "MarketDataMarketCapChange24hInCurrency", - "MarketDataMarketCapChangePercentage24hInCurrency", - "MarketDataPriceChangePercentage14dInCurrency", - "MarketDataPriceChangePercentage1hInCurrency", - "MarketDataPriceChangePercentage1yInCurrency", - "MarketDataPriceChangePercentage200dInCurrency", - "MarketDataPriceChangePercentage24hInCurrency", - "MarketDataPriceChangePercentage30dInCurrency", - "MarketDataPriceChangePercentage60dInCurrency", - "MarketDataPriceChangePercentage7dInCurrency", - "MarketDataTotalVolume", + "MarketDataRoi", "Ticker", "TickerConvertedLast", "TickerConvertedVolume", @@ -44,72 +23,19 @@ ] -class CommunityData(BaseModel): - """coin community data""" - - facebook_likes: Optional[float] = None - """coin facebook likes""" - - reddit_accounts_active_48h: Optional[float] = None - """coin reddit active accounts in 48 hours""" - - reddit_average_comments_48h: Optional[float] = None - """coin reddit average comments in 48 hours""" - - reddit_average_posts_48h: Optional[float] = None - """coin reddit average posts in 48 hours""" - - reddit_subscribers: Optional[float] = None - """coin reddit subscribers""" - - telegram_channel_user_count: Optional[float] = None - """coin telegram channel user count""" - - -class DeveloperDataCodeAdditionsDeletions4Weeks(BaseModel): - """coin code additions and deletions in 4 weeks""" - - additions: Optional[float] = None - - deletions: Optional[float] = None - - -class DeveloperData(BaseModel): - """coin developer data""" - - closed_issues: Optional[float] = None - """coin repository closed issues""" - - code_additions_deletions_4_weeks: Optional[DeveloperDataCodeAdditionsDeletions4Weeks] = None - """coin code additions and deletions in 4 weeks""" - - commit_count_4_weeks: Optional[float] = None - """coin repository commit count in 4 weeks""" - - forks: Optional[float] = None - """coin repository forks""" - - last_4_weeks_commit_activity_series: Optional[List[float]] = None - """coin repository last 4 weeks commit activity series""" - - pull_request_contributors: Optional[float] = None - """coin repository pull request contributors""" +class DetailPlatforms(BaseModel): + contract_address: Optional[str] = None + """Token contract address""" - pull_requests_merged: Optional[float] = None - """coin repository pull requests merged""" + decimal_place: Optional[int] = None + """Token decimal place""" - stars: Optional[float] = None - """coin repository stars""" - - subscribers: Optional[float] = None - """coin repository subscribers""" - - total_issues: Optional[float] = None - """coin repository total issues""" + geckoterminal_url: Optional[str] = None + """GeckoTerminal URL""" class Image(BaseModel): - """coin image url""" + """Coin image URL""" large: Optional[str] = None @@ -119,421 +45,302 @@ class Image(BaseModel): class LinksReposURL(BaseModel): - """coin repository url""" + """Repository URL""" bitbucket: Optional[List[str]] = None - """coin bitbucket repository url""" + """Bitbucket repository URL""" github: Optional[List[str]] = None - """coin github repository url""" + """GitHub repository URL""" class Links(BaseModel): - """links""" + """Links""" announcement_url: Optional[List[str]] = None - """coin announcement url""" + """Announcement URL""" - bitcointalk_thread_identifier: Optional[str] = None - """coin bitcointalk thread identifier""" + bitcointalk_thread_identifier: Optional[int] = None + """Bitcointalk thread identifier""" blockchain_site: Optional[List[str]] = None - """coin block explorer url""" + """Block explorer URL""" chat_url: Optional[List[str]] = None - """coin chat url""" + """Chat URL""" facebook_username: Optional[str] = None - """coin facebook username""" + """Facebook username""" homepage: Optional[List[str]] = None - """coin website url""" + """Website URL""" official_forum_url: Optional[List[str]] = None - """coin official forum url""" + """Official forum URL""" repos_url: Optional[LinksReposURL] = None - """coin repository url""" + """Repository URL""" snapshot_url: Optional[str] = None - """coin snapshot url""" + """Snapshot URL""" subreddit_url: Optional[str] = None - """coin subreddit url""" + """Subreddit URL""" telegram_channel_identifier: Optional[str] = None - """coin telegram channel identifier""" + """Telegram channel identifier""" twitter_screen_name: Optional[str] = None - """coin twitter handle""" - - whitepaper: Optional[List[str]] = None - """coin whitepaper url""" - - -class MarketDataAth(BaseModel): - """coin all time high (ATH) in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataAthChangePercentage(BaseModel): - """coin all time high (ATH) change in percentage""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataAthDate(BaseModel): - """coin all time high (ATH) date""" - - btc: Optional[str] = None - - eur: Optional[str] = None - - usd: Optional[str] = None - - -class MarketDataAtl(BaseModel): - """coin all time low (atl) in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataAtlChangePercentage(BaseModel): - """coin all time low (atl) change in percentage""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataAtlDate(BaseModel): - """coin all time low (atl) date""" - - btc: Optional[str] = None - - eur: Optional[str] = None - - usd: Optional[str] = None - - -class MarketDataCurrentPrice(BaseModel): - """coin current price in currency""" - - btc: Optional[float] = None + """Twitter handle""" - eur: Optional[float] = None - - usd: Optional[float] = None + whitepaper: Optional[str] = None + """Whitepaper URL""" -class MarketDataFullyDilutedValuation(BaseModel): - """coin fully diluted valuation (fdv) in currency""" +class StatusUpdate(BaseModel): + category: Optional[str] = None + """Status update category""" - btc: Optional[float] = None + created_at: Optional[str] = None + """Status update creation time""" - eur: Optional[float] = None + description: Optional[str] = None + """Status update description""" - usd: Optional[float] = None + user: Optional[str] = None + """Status update user""" + user_title: Optional[str] = None + """Status update user title""" -class MarketDataHigh24h(BaseModel): - """coin 24hr price high in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataLow24h(BaseModel): - """coin 24hr price low in currency""" - - btc: Optional[float] = None - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataMarketCap(BaseModel): - """coin market cap in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataMarketCapChange24hInCurrency(BaseModel): - """coin 24hr market cap change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataMarketCapChangePercentage24hInCurrency(BaseModel): - """coin 24hr market cap change in percentage""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage14dInCurrency(BaseModel): - """coin 14d price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage1hInCurrency(BaseModel): - """coin 1h price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage1yInCurrency(BaseModel): - """coin 1y price change in currency""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataPriceChangePercentage200dInCurrency(BaseModel): - """coin 200d price change in currency""" - - btc: Optional[float] = None +class CommunityData(BaseModel): + """Community data""" - eur: Optional[float] = None + facebook_likes: Optional[float] = None + """Facebook likes""" - usd: Optional[float] = None + reddit_accounts_active_48h: Optional[float] = None + """Reddit active accounts in 48 hours""" + reddit_average_comments_48h: Optional[float] = None + """Reddit average comments in 48 hours""" -class MarketDataPriceChangePercentage24hInCurrency(BaseModel): - """coin 24hr price change in currency""" + reddit_average_posts_48h: Optional[float] = None + """Reddit average posts in 48 hours""" - btc: Optional[float] = None + reddit_subscribers: Optional[float] = None + """Reddit subscribers""" - eur: Optional[float] = None + telegram_channel_user_count: Optional[float] = None + """Telegram channel user count""" - usd: Optional[float] = None +class DeveloperDataCodeAdditionsDeletions4Weeks(BaseModel): + """Code additions and deletions in 4 weeks""" -class MarketDataPriceChangePercentage30dInCurrency(BaseModel): - """coin 30d price change in currency""" + additions: Optional[float] = None - btc: Optional[float] = None + deletions: Optional[float] = None - eur: Optional[float] = None - usd: Optional[float] = None +class DeveloperData(BaseModel): + """Developer data""" + closed_issues: Optional[float] = None + """Repository closed issues""" -class MarketDataPriceChangePercentage60dInCurrency(BaseModel): - """coin 60d price change in currency""" + code_additions_deletions_4_weeks: Optional[DeveloperDataCodeAdditionsDeletions4Weeks] = None + """Code additions and deletions in 4 weeks""" - btc: Optional[float] = None + commit_count_4_weeks: Optional[float] = None + """Repository commit count in 4 weeks""" - eur: Optional[float] = None + forks: Optional[float] = None + """Repository forks""" - usd: Optional[float] = None + last_4_weeks_commit_activity_series: Optional[List[float]] = None + """Repository last 4 weeks commit activity series""" + pull_request_contributors: Optional[float] = None + """Repository pull request contributors""" -class MarketDataPriceChangePercentage7dInCurrency(BaseModel): - """coin 7d price change in currency""" + pull_requests_merged: Optional[float] = None + """Repository pull requests merged""" - btc: Optional[float] = None + stars: Optional[float] = None + """Repository stars""" - eur: Optional[float] = None + subscribers: Optional[float] = None + """Repository subscribers""" - usd: Optional[float] = None + total_issues: Optional[float] = None + """Repository total issues""" -class MarketDataTotalVolume(BaseModel): - """coin total trading volume in currency""" +class MarketDataRoi(BaseModel): + """Return on investment""" - btc: Optional[float] = None + currency: Optional[str] = None + """ROI currency""" - eur: Optional[float] = None + percentage: Optional[float] = None + """ROI percentage""" - usd: Optional[float] = None + times: Optional[float] = None + """ROI multiplier""" class MarketData(BaseModel): - """coin market data""" + """Market data""" - ath: Optional[MarketDataAth] = None - """coin all time high (ATH) in currency""" + ath: Optional[Dict[str, float]] = None + """All-time high in target currency""" - ath_change_percentage: Optional[MarketDataAthChangePercentage] = None - """coin all time high (ATH) change in percentage""" + ath_change_percentage: Optional[Dict[str, float]] = None + """All-time high change percentage""" - ath_date: Optional[MarketDataAthDate] = None - """coin all time high (ATH) date""" + ath_date: Optional[Dict[str, str]] = None + """All-time high date""" - atl: Optional[MarketDataAtl] = None - """coin all time low (atl) in currency""" + atl: Optional[Dict[str, float]] = None + """All-time low in target currency""" - atl_change_percentage: Optional[MarketDataAtlChangePercentage] = None - """coin all time low (atl) change in percentage""" + atl_change_percentage: Optional[Dict[str, float]] = None + """All-time low change percentage""" - atl_date: Optional[MarketDataAtlDate] = None - """coin all time low (atl) date""" + atl_date: Optional[Dict[str, str]] = None + """All-time low date""" circulating_supply: Optional[float] = None - """coin circulating supply""" + """Circulating supply""" - current_price: Optional[MarketDataCurrentPrice] = None - """coin current price in currency""" + current_price: Optional[Dict[str, float]] = None + """Current price in target currency""" fdv_to_tvl_ratio: Optional[float] = None - """fully diluted valuation to total value locked ratio""" + """FDV to TVL ratio""" - fully_diluted_valuation: Optional[MarketDataFullyDilutedValuation] = None - """coin fully diluted valuation (fdv) in currency""" + fully_diluted_valuation: Optional[Dict[str, float]] = None + """Fully diluted valuation in target currency""" - high_24h: Optional[MarketDataHigh24h] = None - """coin 24hr price high in currency""" + high_24h: Optional[Dict[str, float]] = None + """24h price high in target currency""" - last_updated: Optional[datetime] = None - """coin market data last updated timestamp""" + last_updated: Optional[str] = None + """Market data last updated timestamp""" - low_24h: Optional[MarketDataLow24h] = None - """coin 24hr price low in currency""" + low_24h: Optional[Dict[str, float]] = None + """24h price low in target currency""" - market_cap: Optional[MarketDataMarketCap] = None - """coin market cap in currency""" + market_cap: Optional[Dict[str, float]] = None + """Market cap in target currency""" market_cap_change_24h: Optional[float] = None - """coin 24hr market cap change in currency""" + """24h market cap change in target currency""" - market_cap_change_24h_in_currency: Optional[MarketDataMarketCapChange24hInCurrency] = None - """coin 24hr market cap change in currency""" + market_cap_change_24h_in_currency: Optional[Dict[str, float]] = None + """24h market cap change in target currency""" market_cap_change_percentage_24h: Optional[float] = None - """coin 24hr market cap change in percentage""" + """24h market cap change percentage""" - market_cap_change_percentage_24h_in_currency: Optional[MarketDataMarketCapChangePercentage24hInCurrency] = None - """coin 24hr market cap change in percentage""" + market_cap_change_percentage_24h_in_currency: Optional[Dict[str, float]] = None + """24h market cap change percentage per currency""" market_cap_fdv_ratio: Optional[float] = None - """market cap to fully diluted valuation ratio""" + """Market cap to FDV ratio""" - market_cap_rank: Optional[float] = None - """coin rank by market cap""" + market_cap_rank: Optional[int] = None + """Market cap rank""" - market_cap_rank_with_rehypothecated: Optional[float] = None - """coin rank by market cap including rehypothecated tokens""" + market_cap_rank_with_rehypothecated: Optional[int] = None + """Market cap rank including rehypothecated tokens""" max_supply: Optional[float] = None - """coin max supply""" + """Max supply""" + + max_supply_infinite: Optional[bool] = None + """Max supply infinite""" mcap_to_tvl_ratio: Optional[float] = None - """market cap to total value locked ratio""" + """Market cap to TVL ratio""" outstanding_supply: Optional[float] = None - """ - tokens outstanding in the market, circulated/tradable or planned for circulation - """ + """Tokens outstanding in the market""" outstanding_token_value_usd: Optional[float] = None - """outstanding token value in USD""" + """Outstanding token value in USD""" price_change_24h: Optional[float] = None - """coin 24hr price change in currency""" + """24h price change in target currency""" + + price_change_24h_in_currency: Optional[Dict[str, float]] = None + """24h price change in target currency""" price_change_percentage_14d: Optional[float] = None - """coin 14d price change in percentage""" + """14d price change percentage""" - price_change_percentage_14d_in_currency: Optional[MarketDataPriceChangePercentage14dInCurrency] = None - """coin 14d price change in currency""" + price_change_percentage_14d_in_currency: Optional[Dict[str, float]] = None + """14d price change percentage per currency""" - price_change_percentage_1h_in_currency: Optional[MarketDataPriceChangePercentage1hInCurrency] = None - """coin 1h price change in currency""" + price_change_percentage_1h_in_currency: Optional[Dict[str, float]] = None + """1h price change percentage per currency""" price_change_percentage_1y: Optional[float] = None - """coin 1y price change in percentage""" + """1y price change percentage""" - price_change_percentage_1y_in_currency: Optional[MarketDataPriceChangePercentage1yInCurrency] = None - """coin 1y price change in currency""" + price_change_percentage_1y_in_currency: Optional[Dict[str, float]] = None + """1y price change percentage per currency""" price_change_percentage_200d: Optional[float] = None - """coin 200d price change in percentage""" + """200d price change percentage""" - price_change_percentage_200d_in_currency: Optional[MarketDataPriceChangePercentage200dInCurrency] = None - """coin 200d price change in currency""" + price_change_percentage_200d_in_currency: Optional[Dict[str, float]] = None + """200d price change percentage per currency""" price_change_percentage_24h: Optional[float] = None - """coin 24hr price change in percentage""" + """24h price change percentage""" - price_change_percentage_24h_in_currency: Optional[MarketDataPriceChangePercentage24hInCurrency] = None - """coin 24hr price change in currency""" + price_change_percentage_24h_in_currency: Optional[Dict[str, float]] = None + """24h price change percentage per currency""" price_change_percentage_30d: Optional[float] = None - """coin 30d price change in percentage""" + """30d price change percentage""" - price_change_percentage_30d_in_currency: Optional[MarketDataPriceChangePercentage30dInCurrency] = None - """coin 30d price change in currency""" + price_change_percentage_30d_in_currency: Optional[Dict[str, float]] = None + """30d price change percentage per currency""" price_change_percentage_60d: Optional[float] = None - """coin 60d price change in percentage""" + """60d price change percentage""" - price_change_percentage_60d_in_currency: Optional[MarketDataPriceChangePercentage60dInCurrency] = None - """coin 60d price change in currency""" + price_change_percentage_60d_in_currency: Optional[Dict[str, float]] = None + """60d price change percentage per currency""" price_change_percentage_7d: Optional[float] = None - """coin 7d price change in percentage""" + """7d price change percentage""" - price_change_percentage_7d_in_currency: Optional[MarketDataPriceChangePercentage7dInCurrency] = None - """coin 7d price change in currency""" + price_change_percentage_7d_in_currency: Optional[Dict[str, float]] = None + """7d price change percentage per currency""" - roi: Optional[float] = None - """coin return on investment""" + roi: Optional[MarketDataRoi] = None + """Return on investment""" + + sparkline_7d: Optional[List[float]] = None + """Sparkline 7-day price data""" total_supply: Optional[float] = None - """coin total supply""" + """Total supply""" total_value_locked: Optional[float] = None - """total value locked""" + """Total value locked""" - total_volume: Optional[MarketDataTotalVolume] = None - """coin total trading volume in currency""" + total_volume: Optional[Dict[str, float]] = None + """Total trading volume in target currency""" class TickerConvertedLast(BaseModel): - """coin ticker converted last price""" + """Ticker converted last price""" btc: Optional[float] = None @@ -543,7 +350,7 @@ class TickerConvertedLast(BaseModel): class TickerConvertedVolume(BaseModel): - """coin ticker converted volume""" + """Ticker converted volume""" btc: Optional[float] = None @@ -553,167 +360,167 @@ class TickerConvertedVolume(BaseModel): class TickerMarket(BaseModel): - """coin ticker exchange""" + """Ticker exchange""" has_trading_incentive: Optional[bool] = None - """coin ticker exchange trading incentive""" + """Exchange trading incentive""" identifier: Optional[str] = None - """coin ticker exchange identifier""" + """Exchange identifier""" name: Optional[str] = None - """coin ticker exchange name""" + """Exchange name""" class Ticker(BaseModel): base: Optional[str] = None - """coin ticker base currency""" + """Ticker base currency""" bid_ask_spread_percentage: Optional[float] = None - """coin ticker bid ask spread percentage""" + """Ticker bid-ask spread percentage""" coin_id: Optional[str] = None - """coin ticker base currency coin ID""" + """Ticker base currency coin ID""" coin_mcap_usd: Optional[float] = None - """coin market cap in usd""" + """Market cap in USD""" converted_last: Optional[TickerConvertedLast] = None - """coin ticker converted last price""" + """Ticker converted last price""" converted_volume: Optional[TickerConvertedVolume] = None - """coin ticker converted volume""" + """Ticker converted volume""" is_anomaly: Optional[bool] = None - """coin ticker anomaly""" + """Ticker anomaly""" is_stale: Optional[bool] = None - """coin ticker stale""" + """Ticker stale""" last: Optional[float] = None - """coin ticker last price""" + """Ticker last price""" - last_fetch_at: Optional[datetime] = None - """coin ticker last fetch timestamp""" + last_fetch_at: Optional[str] = None + """Ticker last fetch timestamp""" - last_traded_at: Optional[datetime] = None - """coin ticker last traded timestamp""" + last_traded_at: Optional[str] = None + """Ticker last traded timestamp""" market: Optional[TickerMarket] = None - """coin ticker exchange""" + """Ticker exchange""" target: Optional[str] = None - """coin ticker target currency""" + """Ticker target currency""" target_coin_id: Optional[str] = None - """coin ticker target currency coin ID""" + """Ticker target currency coin ID""" - timestamp: Optional[datetime] = None - """coin ticker timestamp""" + timestamp: Optional[str] = None + """Ticker timestamp""" token_info_url: Optional[str] = None - """coin ticker token info url""" + """Ticker token info URL""" trade_url: Optional[str] = None - """coin ticker trade url""" + """Ticker trade URL""" trust_score: Optional[str] = None - """coin ticker trust score""" + """Ticker trust score""" volume: Optional[float] = None - """coin ticker volume""" + """Ticker volume""" class ContractGetResponse(BaseModel): - id: Optional[str] = None - """coin ID""" + id: str + """Coin ID""" - additional_notices: Optional[List[str]] = None - """additional notices""" + additional_notices: List[str] + """Additional notices""" asset_platform_id: Optional[str] = None - """coin asset platform ID""" + """Coin asset platform ID""" - block_time_in_minutes: Optional[float] = None - """blockchain block time in minutes""" + block_time_in_minutes: float + """Blockchain block time in minutes""" - categories: Optional[List[str]] = None - """coin categories""" + categories: List[str] + """Coin categories""" - community_data: Optional[CommunityData] = None - """coin community data""" + contract_address: str + """Coin contract address""" - contract_address: Optional[str] = None - """coin contract address""" + country_origin: str + """Country of origin""" - country_origin: Optional[str] = None - """coin country of origin""" + description: Dict[str, str] + """Coin description""" - description: Optional[Dict[str, str]] = None - """coin description""" + detail_platforms: Dict[str, DetailPlatforms] + """Detailed coin asset platform and contract address""" - detail_platforms: Optional[Dict[str, DetailPlatformData]] = None - """detailed coin asset platform and contract address""" - - developer_data: Optional[DeveloperData] = None - """coin developer data""" - - genesis_date: Optional[datetime] = None - """coin genesis date""" + genesis_date: Optional[str] = None + """Genesis date""" hashing_algorithm: Optional[str] = None - """blockchain hashing algorithm""" + """Blockchain hashing algorithm""" - image: Optional[Image] = None - """coin image url""" + image: Image + """Coin image URL""" - last_updated: Optional[datetime] = None - """coin last updated timestamp""" + last_updated: str + """Last updated timestamp""" - links: Optional[Links] = None - """links""" + links: Links + """Links""" - localization: Optional[Dict[str, str]] = None - """coin name localization""" + market_cap_rank: Optional[int] = None + """Market cap rank""" - market_cap_rank: Optional[float] = None - """coin rank by market cap""" + market_cap_rank_with_rehypothecated: Optional[int] = None + """Market cap rank including rehypothecated tokens""" - market_cap_rank_with_rehypothecated: Optional[float] = None - """coin rank by market cap including rehypothecated tokens""" + name: str + """Coin name""" - market_data: Optional[MarketData] = None - """coin market data""" + platforms: Dict[str, str] + """Coin asset platform and contract address""" - name: Optional[str] = None - """coin name""" - - platforms: Optional[Dict[str, Optional[str]]] = None - """coin asset platform and contract address""" - - preview_listing: Optional[bool] = None - """preview listing coin""" + preview_listing: bool + """Preview listing coin""" public_notice: Optional[str] = None - """public notice""" + """Public notice""" sentiment_votes_down_percentage: Optional[float] = None - """coin sentiment votes down percentage""" + """Sentiment votes down percentage""" sentiment_votes_up_percentage: Optional[float] = None - """coin sentiment votes up percentage""" + """Sentiment votes up percentage""" - status_updates: Optional[List[str]] = None - """coin status updates""" + status_updates: List[StatusUpdate] + """Status updates""" - symbol: Optional[str] = None - """coin symbol""" + symbol: str + """Coin symbol""" - tickers: Optional[List[Ticker]] = None - """coin tickers""" + watchlist_portfolio_users: float + """Number of users watching this coin in portfolio""" + + web_slug: str + """Coin web slug""" + + community_data: Optional[CommunityData] = None + """Community data""" - watchlist_portfolio_users: Optional[float] = None - """number of users watching this coin in portfolio""" + developer_data: Optional[DeveloperData] = None + """Developer data""" + + localization: Optional[Dict[str, str]] = None + """Coin name localization""" - web_slug: Optional[str] = None - """coin web slug""" + market_data: Optional[MarketData] = None + """Market data""" + + tickers: Optional[List[Ticker]] = None + """Tickers""" diff --git a/src/coingecko_sdk/types/coins/history_get_params.py b/src/coingecko_sdk/types/coins/history_get_params.py index 3356177..fd02fc1 100644 --- a/src/coingecko_sdk/types/coins/history_get_params.py +++ b/src/coingecko_sdk/types/coins/history_get_params.py @@ -9,7 +9,7 @@ class HistoryGetParams(TypedDict, total=False): date: Required[str] - """date of data snapshot (`YYYY-MM-DD`)""" + """The date of data snapshot. Format: `YYYY-MM-DD`""" localization: bool - """include all the localized languages in response, default: true""" + """Include all the localized languages in response. Default: true""" diff --git a/src/coingecko_sdk/types/coins/history_get_response.py b/src/coingecko_sdk/types/coins/history_get_response.py index 3c03e31..2454c95 100644 --- a/src/coingecko_sdk/types/coins/history_get_response.py +++ b/src/coingecko_sdk/types/coins/history_get_response.py @@ -11,156 +11,127 @@ "DeveloperDataCodeAdditionsDeletions4Weeks", "Image", "MarketData", - "MarketDataCurrentPrice", - "MarketDataMarketCap", - "MarketDataTotalVolume", "PublicInterestStats", ] class CommunityData(BaseModel): - """coin community data""" + """Community engagement data""" facebook_likes: Optional[float] = None - """coin facebook likes""" + """Number of Facebook likes""" reddit_accounts_active_48h: Optional[float] = None - """coin reddit accounts active 48h""" + """Active Reddit accounts in 48 hours""" reddit_average_comments_48h: Optional[float] = None - """coin reddit average comments 48h""" + """Average Reddit comments in 48 hours""" reddit_average_posts_48h: Optional[float] = None - """coin reddit average posts 48h""" + """Average Reddit posts in 48 hours""" reddit_subscribers: Optional[float] = None - """coin reddit subscribers""" + """Number of Reddit subscribers""" class DeveloperDataCodeAdditionsDeletions4Weeks(BaseModel): - """coin code additions deletions 4 weeks""" + """Code additions and deletions in the last 4 weeks""" additions: Optional[float] = None + """Lines added""" deletions: Optional[float] = None + """Lines deleted""" class DeveloperData(BaseModel): - """coin developer data""" + """Developer activity data""" closed_issues: Optional[float] = None - """coin repository closed issues""" + """Closed issues""" code_additions_deletions_4_weeks: Optional[DeveloperDataCodeAdditionsDeletions4Weeks] = None - """coin code additions deletions 4 weeks""" + """Code additions and deletions in the last 4 weeks""" commit_count_4_weeks: Optional[float] = None - """coin commit count 4 weeks""" + """Commit count in the last 4 weeks""" forks: Optional[float] = None - """coin repository forks""" + """Repository forks""" pull_request_contributors: Optional[float] = None - """coin repository pull request contributors""" + """Pull request contributors""" pull_requests_merged: Optional[float] = None - """coin repository pull requests merged""" + """Pull requests merged""" stars: Optional[float] = None - """coin repository stars""" + """Repository stars""" subscribers: Optional[float] = None - """coin repository subscribers""" + """Repository subscribers""" total_issues: Optional[float] = None - """coin repository total issues""" + """Total issues""" class Image(BaseModel): - """coin image url""" + """Coin image URLs""" small: Optional[str] = None + """Small image URL""" thumb: Optional[str] = None - - -class MarketDataCurrentPrice(BaseModel): - """coin current price""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataMarketCap(BaseModel): - """coin market cap""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None - - -class MarketDataTotalVolume(BaseModel): - """coin total volume""" - - btc: Optional[float] = None - - eur: Optional[float] = None - - usd: Optional[float] = None + """Thumbnail image URL""" class MarketData(BaseModel): - """coin market data""" + """Market data at the given date""" - current_price: Optional[MarketDataCurrentPrice] = None - """coin current price""" + current_price: Optional[Dict[str, float]] = None + """Current price keyed by currency""" - market_cap: Optional[MarketDataMarketCap] = None - """coin market cap""" + market_cap: Optional[Dict[str, float]] = None + """Market capitalization keyed by currency""" - total_volume: Optional[MarketDataTotalVolume] = None - """coin total volume""" + total_volume: Optional[Dict[str, float]] = None + """Total trading volume keyed by currency""" class PublicInterestStats(BaseModel): - """coin public interest stats""" + """Public interest statistics""" alexa_rank: Optional[float] = None - """coin alexa rank""" + """Alexa rank""" bing_matches: Optional[float] = None - """coin bing matches""" + """Bing search matches""" class HistoryGetResponse(BaseModel): - id: Optional[str] = None - """coin ID""" + id: str + """Coin ID""" - community_data: Optional[CommunityData] = None - """coin community data""" + community_data: CommunityData + """Community engagement data""" - developer_data: Optional[DeveloperData] = None - """coin developer data""" + developer_data: DeveloperData + """Developer activity data""" - image: Optional[Image] = None - """coin image url""" + image: Image + """Coin image URLs""" - localization: Optional[Dict[str, str]] = None - """coin localization""" + market_data: MarketData + """Market data at the given date""" - market_data: Optional[MarketData] = None - """coin market data""" + name: str + """Coin name""" - name: Optional[str] = None - """coin name""" + public_interest_stats: PublicInterestStats + """Public interest statistics""" - public_interest_stats: Optional[PublicInterestStats] = None - """coin public interest stats""" + symbol: str + """Coin symbol""" - symbol: Optional[str] = None - """coin symbol""" + localization: Optional[Dict[str, str]] = None + """Localized coin names keyed by locale code""" diff --git a/src/coingecko_sdk/types/coins/list_get_new_response.py b/src/coingecko_sdk/types/coins/list_get_new_response.py index 6d36045..8595887 100644 --- a/src/coingecko_sdk/types/coins/list_get_new_response.py +++ b/src/coingecko_sdk/types/coins/list_get_new_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from typing_extensions import TypeAlias from ..._models import BaseModel @@ -9,17 +9,17 @@ class ListGetNewResponseItem(BaseModel): - id: Optional[str] = None - """coin ID""" + id: str + """Coin ID""" - activated_at: Optional[float] = None - """timestamp when coin was activated on CoinGecko""" + activated_at: int + """Timestamp when coin was activated on CoinGecko""" - name: Optional[str] = None - """coin name""" + name: str + """Coin name""" - symbol: Optional[str] = None - """coin symbol""" + symbol: str + """Coin symbol""" ListGetNewResponse: TypeAlias = List[ListGetNewResponseItem] diff --git a/src/coingecko_sdk/types/coins/list_get_params.py b/src/coingecko_sdk/types/coins/list_get_params.py index e44575a..d1a45f0 100644 --- a/src/coingecko_sdk/types/coins/list_get_params.py +++ b/src/coingecko_sdk/types/coins/list_get_params.py @@ -9,7 +9,7 @@ class ListGetParams(TypedDict, total=False): include_platform: bool - """include platform and token's contract addresses, default: false""" + """Include platform and token's contract addresses. Default: false""" status: Literal["active", "inactive"] - """filter by status of coins, default: active""" + """Filter by status of coins. Default: active""" diff --git a/src/coingecko_sdk/types/coins/list_get_response.py b/src/coingecko_sdk/types/coins/list_get_response.py index 5329737..26f19b9 100644 --- a/src/coingecko_sdk/types/coins/list_get_response.py +++ b/src/coingecko_sdk/types/coins/list_get_response.py @@ -9,17 +9,17 @@ class ListGetResponseItem(BaseModel): - id: Optional[str] = None - """coin ID""" + id: str + """Coin ID""" - name: Optional[str] = None - """coin name""" + name: str + """Coin name""" - platforms: Optional[Dict[str, str]] = None - """coin asset platform and contract address""" + symbol: str + """Coin symbol""" - symbol: Optional[str] = None - """coin symbol""" + platforms: Optional[Dict[str, Optional[str]]] = None + """Asset platform and contract address""" ListGetResponse: TypeAlias = List[ListGetResponseItem] diff --git a/src/coingecko_sdk/types/coins/market_chart_get_params.py b/src/coingecko_sdk/types/coins/market_chart_get_params.py index cbc6277..d1a2fb1 100644 --- a/src/coingecko_sdk/types/coins/market_chart_get_params.py +++ b/src/coingecko_sdk/types/coins/market_chart_get_params.py @@ -9,21 +9,22 @@ class MarketChartGetParams(TypedDict, total=False): days: Required[str] - """ - data up to number of days ago You may use any integer or `max` for number of - days + """Data up to number of days ago. + + You may use any integer or `max` for number of days. """ vs_currency: Required[str] - """ - target currency of market data \\**refers to + """Target currency of market data. + + \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). """ interval: Literal["5m", "hourly", "daily"] - """data interval, leave empty for auto granularity""" + """Data interval, leave empty for auto granularity.""" precision: Literal[ "full", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18" ] - """decimal place for currency price value""" + """Decimal place for currency price value.""" diff --git a/src/coingecko_sdk/types/coins/market_chart_get_range_params.py b/src/coingecko_sdk/types/coins/market_chart_get_range_params.py index d3b6472..58565ba 100644 --- a/src/coingecko_sdk/types/coins/market_chart_get_range_params.py +++ b/src/coingecko_sdk/types/coins/market_chart_get_range_params.py @@ -12,26 +12,27 @@ class MarketChartGetRangeParams(TypedDict, total=False): from_: Required[Annotated[str, PropertyInfo(alias="from")]] """ - starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ to: Required[str] """ - ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ vs_currency: Required[str] - """ - target currency of market data \\**refers to + """Target currency of market data. + + \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). """ interval: Literal["5m", "hourly", "daily"] - """data interval, leave empty for auto granularity""" + """Data interval, leave empty for auto granularity.""" precision: Literal[ "full", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18" ] - """decimal place for currency price value""" + """Decimal place for currency price value.""" diff --git a/src/coingecko_sdk/types/coins/market_chart_get_range_response.py b/src/coingecko_sdk/types/coins/market_chart_get_range_response.py index f97ee59..8646448 100644 --- a/src/coingecko_sdk/types/coins/market_chart_get_range_response.py +++ b/src/coingecko_sdk/types/coins/market_chart_get_range_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ..._models import BaseModel @@ -8,8 +8,11 @@ class MarketChartGetRangeResponse(BaseModel): - market_caps: Optional[List[List[float]]] = None + market_caps: List[List[float]] + """Market cap data points as [timestamp, market_cap] pairs""" - prices: Optional[List[List[float]]] = None + prices: List[List[float]] + """Price data points as [timestamp, price] pairs""" - total_volumes: Optional[List[List[float]]] = None + total_volumes: List[List[float]] + """Total volume data points as [timestamp, volume] pairs""" diff --git a/src/coingecko_sdk/types/coins/market_chart_get_response.py b/src/coingecko_sdk/types/coins/market_chart_get_response.py index 5dc796d..d8c0dbc 100644 --- a/src/coingecko_sdk/types/coins/market_chart_get_response.py +++ b/src/coingecko_sdk/types/coins/market_chart_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ..._models import BaseModel @@ -8,8 +8,11 @@ class MarketChartGetResponse(BaseModel): - market_caps: Optional[List[List[float]]] = None + market_caps: List[List[float]] + """Market cap data points as [timestamp, market_cap] pairs""" - prices: Optional[List[List[float]]] = None + prices: List[List[float]] + """Price data points as [timestamp, price] pairs""" - total_volumes: Optional[List[List[float]]] = None + total_volumes: List[List[float]] + """Total volume data points as [timestamp, volume] pairs""" diff --git a/src/coingecko_sdk/types/coins/market_get_params.py b/src/coingecko_sdk/types/coins/market_get_params.py index 44ad188..1c8d83c 100644 --- a/src/coingecko_sdk/types/coins/market_get_params.py +++ b/src/coingecko_sdk/types/coins/market_get_params.py @@ -9,33 +9,34 @@ class MarketGetParams(TypedDict, total=False): vs_currency: Required[str] - """ - target currency of coins and market data \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + """Target currency of coins and market data. + + \\**refers to + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) """ category: str - """ - filter based on coins' category \\**refers to - [`/coins/categories/list`](/reference/coins-categories-list). + """Filter based on coins' category. + + \\**refers to [`/coins/categories/list`](/reference/coins-categories-list) """ ids: str - """coins' IDs, comma-separated if querying more than 1 coin. + """Coins' IDs, comma-separated if querying more than 1 coin. - \\**refers to [`/coins/list`](/reference/coins-list). + \\**refers to [`/coins/list`](/reference/coins-list) """ include_rehypothecated: bool - """ - include rehypothecated tokens in results, default: false When true, returns - `market_cap_rank_with_rehypothecated` field + """Include rehypothecated tokens in results. + + When true, returns `market_cap_rank_with_rehypothecated` field. Default: false """ include_tokens: Literal["top", "all"] - """ - for `symbols` lookups, specify `all` to include all matching tokens Default - `top` returns top-ranked tokens (by market cap or volume) + """For `symbols` lookups, specify `all` to include all matching tokens. + + Default `top` returns top-ranked tokens by market cap or volume. """ locale: Literal[ @@ -74,33 +75,33 @@ class MarketGetParams(TypedDict, total=False): "zh", "zh-tw", ] - """language background, default: en""" + """Language background. Default: en""" names: str - """coins' names, comma-separated if querying more than 1 coin.""" + """Coins' names, comma-separated if querying more than 1 coin.""" order: Literal["market_cap_asc", "market_cap_desc", "volume_asc", "volume_desc", "id_asc", "id_desc"] - """sort result by field, default: market_cap_desc""" + """Sort result by field. Default: market_cap_desc""" - page: float - """page through results, default: 1""" + page: int + """Page through results. Default: 1""" - per_page: float - """total results per page, default: 100 Valid values: 1...250""" + per_page: int + """Total results per page. Default: 100 Valid values: 1...250""" precision: Literal[ "full", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18" ] - """decimal place for currency price value""" + """Decimal places for currency price value""" price_change_percentage: str """ - include price change percentage timeframe, comma-separated if query more than 1 - timeframe Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y + Include price change percentage timeframe, comma-separated if querying more than + 1 timeframe. Valid values: `1h`, `24h`, `7d`, `14d`, `30d`, `200d`, `1y` """ sparkline: bool - """include sparkline 7 days data, default: false""" + """Include sparkline 7-day data. Default: false""" symbols: str - """coins' symbols, comma-separated if querying more than 1 coin.""" + """Coins' symbols, comma-separated if querying more than 1 coin.""" diff --git a/src/coingecko_sdk/types/coins/market_get_response.py b/src/coingecko_sdk/types/coins/market_get_response.py index de9558a..95f5877 100644 --- a/src/coingecko_sdk/types/coins/market_get_response.py +++ b/src/coingecko_sdk/types/coins/market_get_response.py @@ -6,11 +6,16 @@ from ..._models import BaseModel -__all__ = ["MarketGetResponse", "MarketGetResponseItem", "MarketGetResponseItemRoi"] +__all__ = [ + "MarketGetResponse", + "MarketGetResponseItem", + "MarketGetResponseItemRoi", + "MarketGetResponseItemSparklineIn7d", +] class MarketGetResponseItemRoi(BaseModel): - """return on investment data""" + """Return on investment data""" currency: Optional[str] = None """ROI currency""" @@ -22,87 +27,118 @@ class MarketGetResponseItemRoi(BaseModel): """ROI multiplier""" +class MarketGetResponseItemSparklineIn7d(BaseModel): + """Sparkline price data for the last 7 days""" + + price: Optional[List[float]] = None + """Array of price values""" + + class MarketGetResponseItem(BaseModel): - id: Optional[str] = None - """coin ID""" + id: str + """Coin ID""" ath: Optional[float] = None - """coin all time high (ATH) in currency""" + """All-time high price in target currency""" ath_change_percentage: Optional[float] = None - """coin all time high (ATH) change in percentage""" + """All-time high change percentage""" ath_date: Optional[datetime] = None - """coin all time high (ATH) date""" + """All-time high date""" atl: Optional[float] = None - """coin all time low (atl) in currency""" + """All-time low price in target currency""" atl_change_percentage: Optional[float] = None - """coin all time low (atl) change in percentage""" + """All-time low change percentage""" atl_date: Optional[datetime] = None - """coin all time low (atl) date""" + """All-time low date""" circulating_supply: Optional[float] = None - """coin circulating supply""" + """Circulating supply""" current_price: Optional[float] = None - """coin current price in currency""" + """Current price in target currency""" fully_diluted_valuation: Optional[float] = None - """coin fully diluted valuation (fdv) in currency""" + """Fully diluted valuation in target currency""" high_24h: Optional[float] = None - """coin 24hr price high in currency""" + """24-hour price high in target currency""" - image: Optional[str] = None - """coin image url""" + image: str + """Coin image URL""" - last_updated: Optional[datetime] = None - """coin last updated timestamp""" + last_updated: datetime + """Last updated timestamp""" low_24h: Optional[float] = None - """coin 24hr price low in currency""" + """24-hour price low in target currency""" market_cap: Optional[float] = None - """coin market cap in currency""" + """Market cap in target currency""" market_cap_change_24h: Optional[float] = None - """coin 24hr market cap change in currency""" + """24-hour market cap change in target currency""" market_cap_change_percentage_24h: Optional[float] = None - """coin 24hr market cap change in percentage""" - - market_cap_rank: Optional[float] = None - """coin rank by market cap""" + """24-hour market cap change percentage""" - market_cap_rank_with_rehypothecated: Optional[float] = None - """coin rank by market cap including rehypothecated tokens""" + market_cap_rank: Optional[int] = None + """Market cap rank""" max_supply: Optional[float] = None - """coin max supply""" + """Max supply""" - name: Optional[str] = None - """coin name""" + name: str + """Coin name""" price_change_24h: Optional[float] = None - """coin 24hr price change in currency""" + """24-hour price change in target currency""" price_change_percentage_24h: Optional[float] = None - """coin 24hr price change in percentage""" + """24-hour price change percentage""" roi: Optional[MarketGetResponseItemRoi] = None - """return on investment data""" + """Return on investment data""" - symbol: Optional[str] = None - """coin symbol""" + symbol: str + """Coin symbol""" total_supply: Optional[float] = None - """coin total supply""" + """Total supply""" total_volume: Optional[float] = None - """coin total trading volume in currency""" + """Total trading volume in target currency""" + + market_cap_rank_with_rehypothecated: Optional[int] = None + """Market cap rank including rehypothecated tokens""" + + price_change_percentage_14d_in_currency: Optional[float] = None + """14-day price change percentage in target currency""" + + price_change_percentage_1h_in_currency: Optional[float] = None + """1-hour price change percentage in target currency""" + + price_change_percentage_1y_in_currency: Optional[float] = None + """1-year price change percentage in target currency""" + + price_change_percentage_200d_in_currency: Optional[float] = None + """200-day price change percentage in target currency""" + + price_change_percentage_24h_in_currency: Optional[float] = None + """24-hour price change percentage in target currency""" + + price_change_percentage_30d_in_currency: Optional[float] = None + """30-day price change percentage in target currency""" + + price_change_percentage_7d_in_currency: Optional[float] = None + """7-day price change percentage in target currency""" + + sparkline_in_7d: Optional[MarketGetResponseItemSparklineIn7d] = None + """Sparkline price data for the last 7 days""" MarketGetResponse: TypeAlias = List[MarketGetResponseItem] diff --git a/src/coingecko_sdk/types/coins/ohlc_get_params.py b/src/coingecko_sdk/types/coins/ohlc_get_params.py index 25ee6e8..4a289a6 100644 --- a/src/coingecko_sdk/types/coins/ohlc_get_params.py +++ b/src/coingecko_sdk/types/coins/ohlc_get_params.py @@ -9,18 +9,19 @@ class OhlcGetParams(TypedDict, total=False): days: Required[Literal["1", "7", "14", "30", "90", "180", "365", "max"]] - """data up to number of days ago""" + """Data up to number of days ago.""" vs_currency: Required[str] - """ - target currency of price data \\**refers to + """Target currency of price data. + + \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). """ interval: Literal["daily", "hourly"] - """data interval, leave empty for auto granularity""" + """Data interval, leave empty for auto granularity.""" precision: Literal[ "full", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18" ] - """decimal place for currency price value""" + """Decimal place for currency price value.""" diff --git a/src/coingecko_sdk/types/coins/ohlc_get_range_params.py b/src/coingecko_sdk/types/coins/ohlc_get_range_params.py index a5c1bab..9c0701c 100644 --- a/src/coingecko_sdk/types/coins/ohlc_get_range_params.py +++ b/src/coingecko_sdk/types/coins/ohlc_get_range_params.py @@ -12,21 +12,22 @@ class OhlcGetRangeParams(TypedDict, total=False): from_: Required[Annotated[str, PropertyInfo(alias="from")]] """ - starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ interval: Required[Literal["daily", "hourly"]] - """data interval""" + """Data interval.""" to: Required[str] """ - ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ vs_currency: Required[str] - """ - target currency of price data \\**refers to + """Target currency of price data. + + \\**refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). """ diff --git a/src/coingecko_sdk/types/coins/ticker_get_params.py b/src/coingecko_sdk/types/coins/ticker_get_params.py index facd4b1..54cafb9 100644 --- a/src/coingecko_sdk/types/coins/ticker_get_params.py +++ b/src/coingecko_sdk/types/coins/ticker_get_params.py @@ -9,25 +9,25 @@ class TickerGetParams(TypedDict, total=False): depth: bool - """include 2% orderbook depth, ie. + """Include 2% orderbook depth, i.e. - `cost_to_move_up_usd` and `cost_to_move_down_usd` Default: false + `cost_to_move_up_usd` and `cost_to_move_down_usd`. Default: false """ dex_pair_format: Literal["contract_address", "symbol"] - """ - set to `symbol` to display DEX pair base and target as symbols, default: - `contract_address` + """Set to `symbol` to display DEX pair base and target as symbols. + + Default: `contract_address` """ exchange_ids: str - """exchange ID \\**refers to [`/exchanges/list`](/reference/exchanges-list).""" + """Exchange ID. \\**refers to [`/exchanges/list`](/reference/exchanges-list)""" include_exchange_logo: bool - """include exchange logo, default: false""" + """Include exchange logo. Default: false""" order: Literal["trust_score_desc", "trust_score_asc", "volume_desc", "volume_asc"] - """use this to sort the order of responses, default: trust_score_desc""" + """Sort the order of responses. Default: trust_score_desc""" - page: float - """page through results""" + page: int + """Page through results""" diff --git a/src/coingecko_sdk/types/coins/ticker_get_response.py b/src/coingecko_sdk/types/coins/ticker_get_response.py index 3059252..e614b51 100644 --- a/src/coingecko_sdk/types/coins/ticker_get_response.py +++ b/src/coingecko_sdk/types/coins/ticker_get_response.py @@ -8,7 +8,7 @@ class TickerConvertedLast(BaseModel): - """coin ticker converted last price""" + """Converted last price""" btc: Optional[float] = None @@ -18,7 +18,7 @@ class TickerConvertedLast(BaseModel): class TickerConvertedVolume(BaseModel): - """coin ticker converted volume""" + """Converted trading volume""" btc: Optional[float] = None @@ -28,89 +28,89 @@ class TickerConvertedVolume(BaseModel): class TickerMarket(BaseModel): - """coin ticker exchange""" + """Exchange information""" has_trading_incentive: Optional[bool] = None - """exchange trading incentive""" + """Exchange trading incentive""" identifier: Optional[str] = None - """exchange identifier""" + """Exchange identifier""" logo: Optional[str] = None - """exchange image url""" + """Exchange logo URL""" name: Optional[str] = None - """exchange name""" + """Exchange name""" class Ticker(BaseModel): - base: Optional[str] = None - """coin ticker base currency""" + base: str + """Ticker base currency""" - bid_ask_spread_percentage: Optional[float] = None - """coin ticker bid ask spread percentage""" + bid_ask_spread_percentage: float + """Bid-ask spread percentage""" - coin_id: Optional[str] = None - """coin ticker base currency coin ID""" + coin_id: str + """Base currency coin ID""" - coin_mcap_usd: Optional[float] = None - """coin market cap in usd""" + coin_mcap_usd: float + """Coin market cap in USD""" - converted_last: Optional[TickerConvertedLast] = None - """coin ticker converted last price""" + converted_last: TickerConvertedLast + """Converted last price""" - converted_volume: Optional[TickerConvertedVolume] = None - """coin ticker converted volume""" + converted_volume: TickerConvertedVolume + """Converted trading volume""" - cost_to_move_down_usd: Optional[float] = None - """coin ticker cost to move down in usd""" - - cost_to_move_up_usd: Optional[float] = None - """coin ticker cost to move up in usd""" + is_anomaly: bool + """Whether ticker is anomalous""" - is_anomaly: Optional[bool] = None - """coin ticker anomaly""" + is_stale: bool + """Whether ticker is stale""" - is_stale: Optional[bool] = None - """coin ticker stale""" + last: float + """Last price""" - last: Optional[float] = None - """coin ticker last price""" + last_fetch_at: str + """Last fetch timestamp""" - last_fetch_at: Optional[str] = None - """coin ticker last fetch timestamp""" + last_traded_at: str + """Last traded timestamp""" - last_traded_at: Optional[str] = None - """coin ticker last traded timestamp""" + market: TickerMarket + """Exchange information""" - market: Optional[TickerMarket] = None - """coin ticker exchange""" + target: str + """Ticker target currency""" - target: Optional[str] = None - """coin ticker target currency""" + target_coin_id: str + """Target currency coin ID""" - target_coin_id: Optional[str] = None - """coin ticker target currency coin ID""" - - timestamp: Optional[str] = None - """coin ticker timestamp""" + timestamp: str + """Ticker timestamp""" token_info_url: Optional[str] = None - """coin ticker token info url""" + """Token info URL""" - trade_url: Optional[str] = None - """coin ticker trade url""" + trade_url: str + """Trade URL""" trust_score: Optional[str] = None - """coin ticker trust score""" + """Trust score""" - volume: Optional[float] = None - """coin ticker volume""" + volume: float + """Trading volume""" + + cost_to_move_down_usd: Optional[float] = None + """Cost to move price down by 2% in USD""" + + cost_to_move_up_usd: Optional[float] = None + """Cost to move price up by 2% in USD""" class TickerGetResponse(BaseModel): - name: Optional[str] = None - """coin name""" + name: str + """Coin name""" - tickers: Optional[List[Ticker]] = None - """list of tickers""" + tickers: List[Ticker] + """List of tickers""" diff --git a/src/coingecko_sdk/types/coins/top_gainers_loser_get_params.py b/src/coingecko_sdk/types/coins/top_gainers_loser_get_params.py index 959e73e..f4c68e6 100644 --- a/src/coingecko_sdk/types/coins/top_gainers_loser_get_params.py +++ b/src/coingecko_sdk/types/coins/top_gainers_loser_get_params.py @@ -9,22 +9,23 @@ class TopGainersLoserGetParams(TypedDict, total=False): vs_currency: Required[str] - """ - target currency of coins \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + """Target currency of coins. + + \\**refers to + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) """ duration: Literal["1h", "24h", "7d", "14d", "30d", "60d", "1y"] - """filter result by time range Default value: `24h`""" + """Filter result by time range. Default: `24h`""" price_change_percentage: str """ - include price change percentage timeframe, comma-separated if query more than 1 - price change percentage timeframe Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y + Include price change percentage timeframe, comma-separated if querying more than + 1 timeframe. Valid values: `1h`, `24h`, `7d`, `14d`, `30d`, `60d`, `200d`, `1y` """ top_coins: Literal["300", "500", "1000", "all"] """ - filter result by market cap ranking (top 300 to 1000) or all coins (including - coins that do not have market cap) Default value: `1000` + Filter result by market cap ranking (top 300 to 1000) or all coins (including + coins that do not have market cap). Default: `1000` """ diff --git a/src/coingecko_sdk/types/coins/top_gainers_loser_get_response.py b/src/coingecko_sdk/types/coins/top_gainers_loser_get_response.py index 0b082e8..0c64df1 100644 --- a/src/coingecko_sdk/types/coins/top_gainers_loser_get_response.py +++ b/src/coingecko_sdk/types/coins/top_gainers_loser_get_response.py @@ -1,101 +1,14 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ..._models import BaseModel +from .top_gainers_losers_item import TopGainersLosersItem -__all__ = ["TopGainersLoserGetResponse", "TopGainer", "TopLoser"] - - -class TopGainer(BaseModel): - id: Optional[str] = None - """coin ID""" - - image: Optional[str] = None - """coin image url""" - - market_cap_rank: Optional[float] = None - """coin rank by market cap""" - - name: Optional[str] = None - """coin name""" - - symbol: Optional[str] = None - """coin symbol""" - - usd: Optional[float] = None - """coin price in USD""" - - usd_14d_change: Optional[float] = None - """coin 14 day change percentage in USD""" - - usd_1h_change: Optional[float] = None - """coin 1hr change percentage in USD""" - - usd_1y_change: Optional[float] = None - """coin 1 year change percentage in USD""" - - usd_200d_change: Optional[float] = None - """coin 200 day change percentage in USD""" - - usd_24h_change: Optional[float] = None - """coin 24hr change percentage in USD""" - - usd_24h_vol: Optional[float] = None - """coin 24hr volume in USD""" - - usd_30d_change: Optional[float] = None - """coin 30 day change percentage in USD""" - - usd_7d_change: Optional[float] = None - """coin 7 day change percentage in USD""" - - -class TopLoser(BaseModel): - id: Optional[str] = None - """coin ID""" - - image: Optional[str] = None - """coin image url""" - - market_cap_rank: Optional[float] = None - """coin rank by market cap""" - - name: Optional[str] = None - """coin name""" - - symbol: Optional[str] = None - """coin symbol""" - - usd: Optional[float] = None - """coin price in USD""" - - usd_14d_change: Optional[float] = None - """coin 14 day change percentage in USD""" - - usd_1h_change: Optional[float] = None - """coin 1hr change percentage in USD""" - - usd_1y_change: Optional[float] = None - """coin 1 year change percentage in USD""" - - usd_200d_change: Optional[float] = None - """coin 200 day change percentage in USD""" - - usd_24h_change: Optional[float] = None - """coin 24hr change percentage in USD""" - - usd_24h_vol: Optional[float] = None - """coin 24hr volume in USD""" - - usd_30d_change: Optional[float] = None - """coin 30 day change percentage in USD""" - - usd_7d_change: Optional[float] = None - """coin 7 day change percentage in USD""" +__all__ = ["TopGainersLoserGetResponse"] class TopGainersLoserGetResponse(BaseModel): - top_gainers: Optional[List[TopGainer]] = None + top_gainers: List[TopGainersLosersItem] - top_losers: Optional[List[TopLoser]] = None + top_losers: List[TopGainersLosersItem] diff --git a/src/coingecko_sdk/types/coins/top_gainers_losers_item.py b/src/coingecko_sdk/types/coins/top_gainers_losers_item.py new file mode 100644 index 0000000..fb2c2fb --- /dev/null +++ b/src/coingecko_sdk/types/coins/top_gainers_losers_item.py @@ -0,0 +1,54 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from ..._models import BaseModel + +__all__ = ["TopGainersLosersItem"] + + +class TopGainersLosersItem(BaseModel): + id: str + """Coin ID""" + + image: str + """Coin image URL""" + + market_cap_rank: Optional[int] = None + """Coin market cap rank""" + + name: str + """Coin name""" + + symbol: str + """Coin symbol""" + + usd: float + """Coin price in the target currency""" + + usd_24h_change: Optional[float] = None + """24-hour price change percentage""" + + usd_24h_vol: float + """24-hour trading volume in the target currency""" + + usd_14d_change: Optional[float] = None + """14-day price change percentage""" + + usd_1h_change: Optional[float] = None + """1-hour price change percentage""" + + usd_1y_change: Optional[float] = None + """1-year price change percentage""" + + usd_200d_change: Optional[float] = None + """200-day price change percentage""" + + usd_30d_change: Optional[float] = None + """30-day price change percentage""" + + usd_60d_change: Optional[float] = None + """60-day price change percentage""" + + usd_7d_change: Optional[float] = None + """7-day price change percentage""" diff --git a/src/coingecko_sdk/types/coins/total_supply_chart_get_params.py b/src/coingecko_sdk/types/coins/total_supply_chart_get_params.py index 4117590..b90db39 100644 --- a/src/coingecko_sdk/types/coins/total_supply_chart_get_params.py +++ b/src/coingecko_sdk/types/coins/total_supply_chart_get_params.py @@ -9,7 +9,7 @@ class TotalSupplyChartGetParams(TypedDict, total=False): days: Required[str] - """data up to number of days ago Valid values: any integer or `max`""" + """Data up to number of days ago. Valid values: any integer or `max`.""" interval: Literal["daily"] - """data interval""" + """Data interval.""" diff --git a/src/coingecko_sdk/types/coins/total_supply_chart_get_range_params.py b/src/coingecko_sdk/types/coins/total_supply_chart_get_range_params.py index e1c4161..6ce4be0 100644 --- a/src/coingecko_sdk/types/coins/total_supply_chart_get_range_params.py +++ b/src/coingecko_sdk/types/coins/total_supply_chart_get_range_params.py @@ -12,12 +12,12 @@ class TotalSupplyChartGetRangeParams(TypedDict, total=False): from_: Required[Annotated[str, PropertyInfo(alias="from")]] """ - starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ to: Required[str] """ - ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX - timestamp. **use ISO date string for best compatibility** + Ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX + timestamp. **Use ISO date string for best compatibility.** """ diff --git a/src/coingecko_sdk/types/coins/total_supply_chart_get_range_response.py b/src/coingecko_sdk/types/coins/total_supply_chart_get_range_response.py index 8cc4f2e..298dae2 100644 --- a/src/coingecko_sdk/types/coins/total_supply_chart_get_range_response.py +++ b/src/coingecko_sdk/types/coins/total_supply_chart_get_range_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Union, Optional +from typing import List, Union from ..._models import BaseModel @@ -8,4 +8,5 @@ class TotalSupplyChartGetRangeResponse(BaseModel): - total_supply: Optional[List[List[Union[float, str]]]] = None + total_supply: List[List[Union[float, str]]] + """Total supply data points as [timestamp, supply] pairs""" diff --git a/src/coingecko_sdk/types/coins/total_supply_chart_get_response.py b/src/coingecko_sdk/types/coins/total_supply_chart_get_response.py index 8b9bde6..eb04bca 100644 --- a/src/coingecko_sdk/types/coins/total_supply_chart_get_response.py +++ b/src/coingecko_sdk/types/coins/total_supply_chart_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Union, Optional +from typing import List, Union from ..._models import BaseModel @@ -8,4 +8,5 @@ class TotalSupplyChartGetResponse(BaseModel): - total_supply: Optional[List[List[Union[float, str]]]] = None + total_supply: List[List[Union[float, str]]] + """Total supply data points as [timestamp, supply] pairs""" diff --git a/src/coingecko_sdk/types/derivative_get_response.py b/src/coingecko_sdk/types/derivative_get_response.py index 81cd78a..393a39a 100644 --- a/src/coingecko_sdk/types/derivative_get_response.py +++ b/src/coingecko_sdk/types/derivative_get_response.py @@ -9,46 +9,47 @@ class DerivativeGetResponseItem(BaseModel): - basis: Optional[float] = None - """difference of derivative price and index price""" + basis: float + """Difference of derivative price and index price""" - contract_type: Optional[str] = None - """derivative contract type""" + contract_type: str + """Derivative contract type""" - expired_at: Optional[str] = None + expired_at: Optional[float] = None + """Derivative expiry time in UNIX timestamp""" - funding_rate: Optional[float] = None - """derivative funding rate""" + funding_rate: float + """Derivative funding rate""" - index: Optional[float] = None - """derivative underlying asset price""" + index: float + """Derivative underlying asset price""" - index_id: Optional[str] = None - """derivative underlying asset""" + index_id: str + """Derivative underlying asset""" - last_traded_at: Optional[float] = None - """derivative last updated time""" + last_traded_at: float + """Derivative last traded time in UNIX timestamp""" - market: Optional[str] = None - """derivative market name""" + market: str + """Derivative market name""" - open_interest: Optional[float] = None - """derivative open interest""" + open_interest: float + """Derivative open interest""" - price: Optional[str] = None - """derivative ticker price""" + price: str + """Derivative ticker price""" - price_percentage_change_24h: Optional[float] = None - """derivative ticker price percentage change in 24 hours""" + price_percentage_change_24h: float + """Derivative ticker price percentage change in 24 hours""" - spread: Optional[float] = None - """derivative bid ask spread""" + spread: float + """Derivative bid-ask spread""" - symbol: Optional[str] = None - """derivative ticker symbol""" + symbol: str + """Derivative ticker symbol""" - volume_24h: Optional[float] = None - """derivative volume in 24 hours""" + volume_24h: float + """Derivative trading volume in 24 hours""" DerivativeGetResponse: TypeAlias = List[DerivativeGetResponseItem] diff --git a/src/coingecko_sdk/types/derivatives/exchange_get_id_params.py b/src/coingecko_sdk/types/derivatives/exchange_get_id_params.py index 9287907..70d8cc1 100644 --- a/src/coingecko_sdk/types/derivatives/exchange_get_id_params.py +++ b/src/coingecko_sdk/types/derivatives/exchange_get_id_params.py @@ -9,4 +9,4 @@ class ExchangeGetIDParams(TypedDict, total=False): include_tickers: Literal["all", "unexpired"] - """include tickers data""" + """Include tickers data. Default: tickers data is not included.""" diff --git a/src/coingecko_sdk/types/derivatives/exchange_get_id_response.py b/src/coingecko_sdk/types/derivatives/exchange_get_id_response.py index dc26088..c4ca529 100644 --- a/src/coingecko_sdk/types/derivatives/exchange_get_id_response.py +++ b/src/coingecko_sdk/types/derivatives/exchange_get_id_response.py @@ -8,6 +8,8 @@ class TickerConvertedLast(BaseModel): + """Derivative converted last price""" + btc: Optional[str] = None eth: Optional[str] = None @@ -16,6 +18,8 @@ class TickerConvertedLast(BaseModel): class TickerConvertedVolume(BaseModel): + """Derivative converted volume""" + btc: Optional[str] = None eth: Optional[str] = None @@ -24,90 +28,94 @@ class TickerConvertedVolume(BaseModel): class Ticker(BaseModel): - base: Optional[str] = None - """derivative base asset""" + base: str + """Derivative base asset""" - bid_ask_spread: Optional[float] = None - """derivative bid ask spread""" + bid_ask_spread: float + """Derivative bid-ask spread""" - coin_id: Optional[str] = None - """derivative base asset coin ID""" + coin_id: str + """Derivative base asset coin ID""" - contract_type: Optional[str] = None - """derivative contract type""" + contract_type: str + """Derivative contract type""" - converted_last: Optional[TickerConvertedLast] = None + converted_last: TickerConvertedLast + """Derivative converted last price""" - converted_volume: Optional[TickerConvertedVolume] = None + converted_volume: TickerConvertedVolume + """Derivative converted volume""" - expired_at: Optional[str] = None + expired_at: Optional[float] = None + """Derivative expiry time in UNIX timestamp""" - funding_rate: Optional[float] = None - """derivative funding rate""" + funding_rate: float + """Derivative funding rate""" - h24_percentage_change: Optional[float] = None - """derivative price percentage change in 24 hours""" + h24_percentage_change: float + """Derivative price percentage change in 24 hours""" - h24_volume: Optional[float] = None - """derivative volume in 24 hours""" + h24_volume: float + """Derivative volume in 24 hours""" - index: Optional[float] = None - """derivative underlying asset price""" + index: float + """Derivative underlying asset price""" - index_basis_percentage: Optional[float] = None - """difference of derivative price and index price in percentage""" + index_basis_percentage: float + """Difference of derivative price and index price in percentage""" - last: Optional[float] = None - """derivative last price""" + last: float + """Derivative last price""" - last_traded: Optional[float] = None - """derivative last updated time""" + last_traded: float + """Derivative last traded time in UNIX timestamp""" - open_interest_usd: Optional[float] = None - """derivative open interest in USD""" + open_interest_usd: float + """Derivative open interest in USD""" - symbol: Optional[str] = None - """derivative ticker symbol""" + symbol: str + """Derivative ticker symbol""" - target: Optional[str] = None - """derivative target asset""" + target: str + """Derivative target asset""" - target_coin_id: Optional[str] = None - """derivative target asset coin ID""" + target_coin_id: str + """Derivative target asset coin ID""" - trade_url: Optional[str] = None - """derivative trade url""" + trade_url: str + """Derivative trade URL""" class ExchangeGetIDResponse(BaseModel): country: Optional[str] = None - """derivatives exchange incorporated country""" + """Derivatives exchange incorporated country""" - description: Optional[str] = None - """derivatives exchange description""" + description: str + """Derivatives exchange description""" - image: Optional[str] = None - """derivatives exchange image url""" + image: str + """Derivatives exchange image URL""" - name: Optional[str] = None - """derivatives exchange name""" + name: str + """Derivatives exchange name""" - number_of_futures_pairs: Optional[float] = None - """number of futures pairs in the derivatives exchange""" + number_of_futures_pairs: int + """Number of futures pairs in the derivatives exchange""" - number_of_perpetual_pairs: Optional[float] = None - """number of perpetual pairs in the derivatives exchange""" + number_of_perpetual_pairs: int + """Number of perpetual pairs in the derivatives exchange""" open_interest_btc: Optional[float] = None - """derivatives exchange open interest in BTC""" + """Derivatives exchange open interest in BTC""" - tickers: Optional[List[Ticker]] = None + trade_volume_24h_btc: str + """Derivatives exchange trade volume in BTC in 24 hours""" - trade_volume_24h_btc: Optional[str] = None - """derivatives exchange trade volume in BTC in 24 hours""" + url: str + """Derivatives exchange website URL""" - url: Optional[str] = None - """derivatives exchange website url""" + year_established: Optional[int] = None + """Derivatives exchange established year""" - year_established: Optional[float] = None - """derivatives exchange established year""" + tickers: Optional[List[Ticker]] = None + """Derivative tickers data, available when include_tickers is specified""" diff --git a/src/coingecko_sdk/types/derivatives/exchange_get_list_response.py b/src/coingecko_sdk/types/derivatives/exchange_get_list_response.py index dad93ce..9fb1779 100644 --- a/src/coingecko_sdk/types/derivatives/exchange_get_list_response.py +++ b/src/coingecko_sdk/types/derivatives/exchange_get_list_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from typing_extensions import TypeAlias from ..._models import BaseModel @@ -9,11 +9,11 @@ class ExchangeGetListResponseItem(BaseModel): - id: Optional[str] = None - """derivatives exchange ID""" + id: str + """Derivatives exchange ID""" - name: Optional[str] = None - """derivatives exchange name""" + name: str + """Derivatives exchange name""" ExchangeGetListResponse: TypeAlias = List[ExchangeGetListResponseItem] diff --git a/src/coingecko_sdk/types/derivatives/exchange_get_params.py b/src/coingecko_sdk/types/derivatives/exchange_get_params.py index e664fd6..6587de7 100644 --- a/src/coingecko_sdk/types/derivatives/exchange_get_params.py +++ b/src/coingecko_sdk/types/derivatives/exchange_get_params.py @@ -16,10 +16,10 @@ class ExchangeGetParams(TypedDict, total=False): "trade_volume_24h_btc_asc", "trade_volume_24h_btc_desc", ] - """use this to sort the order of responses, default: open_interest_btc_desc""" + """Sort order of responses. Default: `open_interest_btc_desc`""" - page: float - """page through results, default: 1""" + page: int + """Page through results. Default value: 1""" - per_page: float - """total results per page""" + per_page: int + """Total results per page.""" diff --git a/src/coingecko_sdk/types/derivatives/exchange_get_response.py b/src/coingecko_sdk/types/derivatives/exchange_get_response.py index 87dd82c..56e60fb 100644 --- a/src/coingecko_sdk/types/derivatives/exchange_get_response.py +++ b/src/coingecko_sdk/types/derivatives/exchange_get_response.py @@ -9,38 +9,38 @@ class ExchangeGetResponseItem(BaseModel): - id: Optional[str] = None - """derivatives exchange ID""" + id: str + """Derivatives exchange ID""" country: Optional[str] = None - """derivatives exchange incorporated country""" + """Derivatives exchange incorporated country""" - description: Optional[str] = None - """derivatives exchange description""" + description: str + """Derivatives exchange description""" - image: Optional[str] = None - """derivatives exchange image url""" + image: str + """Derivatives exchange image URL""" - name: Optional[str] = None - """derivatives exchange name""" + name: str + """Derivatives exchange name""" - number_of_futures_pairs: Optional[float] = None - """number of futures pairs in the derivatives exchange""" + number_of_futures_pairs: int + """Number of futures pairs in the derivatives exchange""" - number_of_perpetual_pairs: Optional[float] = None - """number of perpetual pairs in the derivatives exchange""" + number_of_perpetual_pairs: int + """Number of perpetual pairs in the derivatives exchange""" - open_interest_btc: Optional[float] = None - """derivatives exchange open interest in BTC""" + open_interest_btc: float + """Derivatives exchange open interest in BTC""" - trade_volume_24h_btc: Optional[str] = None - """derivatives exchange trade volume in BTC in 24 hours""" + trade_volume_24h_btc: str + """Derivatives exchange trade volume in BTC in 24 hours""" - url: Optional[str] = None - """derivatives exchange website url""" + url: str + """Derivatives exchange website URL""" - year_established: Optional[float] = None - """derivatives exchange established year""" + year_established: Optional[int] = None + """Derivatives exchange established year""" ExchangeGetResponse: TypeAlias = List[ExchangeGetResponseItem] diff --git a/src/coingecko_sdk/types/detail_platform_data.py b/src/coingecko_sdk/types/detail_platform_data.py deleted file mode 100644 index 3d53b11..0000000 --- a/src/coingecko_sdk/types/detail_platform_data.py +++ /dev/null @@ -1,15 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -from typing import Optional - -from .._models import BaseModel - -__all__ = ["DetailPlatformData"] - - -class DetailPlatformData(BaseModel): - contract_address: Optional[str] = None - """contract address on the platform""" - - decimal_place: Optional[float] = None - """decimal places for the token""" diff --git a/src/coingecko_sdk/types/entity_get_list_params.py b/src/coingecko_sdk/types/entity_get_list_params.py index 9b3b8cd..2422e16 100644 --- a/src/coingecko_sdk/types/entity_get_list_params.py +++ b/src/coingecko_sdk/types/entity_get_list_params.py @@ -9,10 +9,10 @@ class EntityGetListParams(TypedDict, total=False): entity_type: Literal["company", "government"] - """filter by entity type, default: false""" + """Filter by entity type.""" page: int - """page through results, default: 1""" + """Page through results. Default value: 1""" per_page: int - """total results per page, default: 100 Valid values: 1...250""" + """Total results per page. Default value: 100 Valid values: 1...250""" diff --git a/src/coingecko_sdk/types/entity_get_list_response.py b/src/coingecko_sdk/types/entity_get_list_response.py index 2e3f832..f616c04 100644 --- a/src/coingecko_sdk/types/entity_get_list_response.py +++ b/src/coingecko_sdk/types/entity_get_list_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from typing_extensions import TypeAlias from .._models import BaseModel @@ -9,17 +9,17 @@ class EntityGetListResponseItem(BaseModel): - id: Optional[str] = None - """entity ID""" + id: str + """Entity ID""" - country: Optional[str] = None - """country code""" + country: str + """Country code""" - name: Optional[str] = None - """entity name""" + name: str + """Entity name""" - symbol: Optional[str] = None - """ticker symbol of public company""" + symbol: str + """Ticker symbol of public company""" EntityGetListResponse: TypeAlias = List[EntityGetListResponseItem] diff --git a/src/coingecko_sdk/types/exchange_get_id_params.py b/src/coingecko_sdk/types/exchange_get_id_params.py index bb44def..ef36b74 100644 --- a/src/coingecko_sdk/types/exchange_get_id_params.py +++ b/src/coingecko_sdk/types/exchange_get_id_params.py @@ -9,7 +9,7 @@ class ExchangeGetIDParams(TypedDict, total=False): dex_pair_format: Literal["contract_address", "symbol"] - """ - set to `symbol` to display DEX pair base and target as symbols, default: - `contract_address` + """Set to `symbol` to display DEX pair base and target as symbols. + + Default: `contract_address` """ diff --git a/src/coingecko_sdk/types/exchange_get_id_response.py b/src/coingecko_sdk/types/exchange_get_id_response.py index 83f4910..2570fa1 100644 --- a/src/coingecko_sdk/types/exchange_get_id_response.py +++ b/src/coingecko_sdk/types/exchange_get_id_response.py @@ -10,14 +10,15 @@ "StatusUpdateProject", "StatusUpdateProjectImage", "Ticker", - "TickerTicker", - "TickerTickerConvertedLast", - "TickerTickerConvertedVolume", - "TickerTickerMarket", + "TickerConvertedLast", + "TickerConvertedVolume", + "TickerMarket", ] class StatusUpdateProjectImage(BaseModel): + """Project image URLs""" + large: Optional[str] = None small: Optional[str] = None @@ -26,33 +27,46 @@ class StatusUpdateProjectImage(BaseModel): class StatusUpdateProject(BaseModel): + """Project information""" + id: Optional[str] = None + """Project ID""" image: Optional[StatusUpdateProjectImage] = None + """Project image URLs""" name: Optional[str] = None + """Project name""" type: Optional[str] = None + """Project type""" class StatusUpdate(BaseModel): category: Optional[str] = None + """Status update category""" created_at: Optional[str] = None + """Status update creation time""" description: Optional[str] = None + """Status update description""" pin: Optional[bool] = None + """Whether status update is pinned""" project: Optional[StatusUpdateProject] = None + """Project information""" user: Optional[str] = None + """Status update user""" user_title: Optional[str] = None + """Status update user title""" -class TickerTickerConvertedLast(BaseModel): - """coin ticker converted last price""" +class TickerConvertedLast(BaseModel): + """Converted last price""" btc: Optional[float] = None @@ -61,8 +75,8 @@ class TickerTickerConvertedLast(BaseModel): usd: Optional[float] = None -class TickerTickerConvertedVolume(BaseModel): - """coin ticker converted volume""" +class TickerConvertedVolume(BaseModel): + """Converted trading volume""" btc: Optional[float] = None @@ -71,160 +85,147 @@ class TickerTickerConvertedVolume(BaseModel): usd: Optional[float] = None -class TickerTickerMarket(BaseModel): - """coin ticker exchange""" +class TickerMarket(BaseModel): + """Exchange information""" has_trading_incentive: Optional[bool] = None - """exchange trading incentive""" + """Exchange trading incentive""" identifier: Optional[str] = None - """exchange identifier""" - - logo: Optional[str] = None - """exchange image url""" + """Exchange identifier""" name: Optional[str] = None - """exchange name""" + """Exchange name""" -class TickerTicker(BaseModel): +class Ticker(BaseModel): base: Optional[str] = None - """coin ticker base currency""" + """Ticker base currency""" bid_ask_spread_percentage: Optional[float] = None - """coin ticker bid ask spread percentage""" + """Bid-ask spread percentage""" coin_id: Optional[str] = None - """coin ticker base currency coin ID""" + """Base currency coin ID""" coin_mcap_usd: Optional[float] = None - """coin market cap in usd""" + """Coin market cap in USD""" - converted_last: Optional[TickerTickerConvertedLast] = None - """coin ticker converted last price""" + converted_last: Optional[TickerConvertedLast] = None + """Converted last price""" - converted_volume: Optional[TickerTickerConvertedVolume] = None - """coin ticker converted volume""" - - cost_to_move_down_usd: Optional[float] = None - """coin ticker cost to move down in usd""" - - cost_to_move_up_usd: Optional[float] = None - """coin ticker cost to move up in usd""" + converted_volume: Optional[TickerConvertedVolume] = None + """Converted trading volume""" is_anomaly: Optional[bool] = None - """coin ticker anomaly""" + """Whether ticker is anomalous""" is_stale: Optional[bool] = None - """coin ticker stale""" + """Whether ticker is stale""" last: Optional[float] = None - """coin ticker last price""" + """Last price""" last_fetch_at: Optional[str] = None - """coin ticker last fetch timestamp""" + """Last fetch timestamp""" last_traded_at: Optional[str] = None - """coin ticker last traded timestamp""" + """Last traded timestamp""" - market: Optional[TickerTickerMarket] = None - """coin ticker exchange""" + market: Optional[TickerMarket] = None + """Exchange information""" target: Optional[str] = None - """coin ticker target currency""" + """Ticker target currency""" target_coin_id: Optional[str] = None - """coin ticker target currency coin ID""" + """Target currency coin ID""" timestamp: Optional[str] = None - """coin ticker timestamp""" + """Ticker timestamp""" token_info_url: Optional[str] = None - """coin ticker token info url""" + """Token info URL""" trade_url: Optional[str] = None - """coin ticker trade url""" + """Trade URL""" trust_score: Optional[str] = None - """coin ticker trust score""" + """Trust score""" volume: Optional[float] = None - """coin ticker volume""" - - -class Ticker(BaseModel): - name: Optional[str] = None - """coin name""" - - tickers: Optional[List[TickerTicker]] = None - """list of tickers""" + """Trading volume""" class ExchangeGetIDResponse(BaseModel): - alert_notice: Optional[str] = None - """alert notice for exchange""" + alert_notice: str + """Alert notice""" - centralized: Optional[bool] = None - """exchange type (true for centralized, false for decentralized)""" + centralized: bool + """Whether the exchange is centralized""" - coins: Optional[float] = None - """number of coins listed on the exchange""" + coins: float + """Number of coins listed""" country: Optional[str] = None - """exchange incorporated country""" + """Country where the exchange is based""" - description: Optional[str] = None - """exchange description""" + description: str + """Exchange description""" - facebook_url: Optional[str] = None - """exchange facebook url""" + facebook_url: str + """Facebook URL""" - has_trading_incentive: Optional[bool] = None - """exchange trading incentive""" + has_trading_incentive: bool + """Whether the exchange has trading incentive""" - image: Optional[str] = None - """exchange image url""" + image: str + """Exchange logo URL""" - name: Optional[str] = None - """exchange name""" + name: str + """Exchange name""" - other_url_1: Optional[str] = None + other_url_1: str + """Other URL 1""" - other_url_2: Optional[str] = None + other_url_2: str + """Other URL 2""" - pairs: Optional[float] = None - """number of trading pairs on the exchange""" + pairs: float + """Number of trading pairs""" - public_notice: Optional[str] = None - """public notice for exchange""" + public_notice: str + """Public notice""" - reddit_url: Optional[str] = None - """exchange reddit url""" + reddit_url: str + """Reddit URL""" - slack_url: Optional[str] = None - """exchange slack url""" + slack_url: str + """Slack URL""" - status_updates: Optional[List[StatusUpdate]] = None - """exchange status updates""" + status_updates: List[StatusUpdate] + """Status updates""" - telegram_url: Optional[str] = None - """exchange telegram url""" + telegram_url: str + """Telegram URL""" - tickers: Optional[List[Ticker]] = None + tickers: List[Ticker] + """Exchange tickers""" - trade_volume_24h_btc: Optional[float] = None + trade_volume_24h_btc: float + """Exchange 24h trading volume in BTC""" trust_score: Optional[float] = None - """exchange trust score""" + """Exchange trust score""" trust_score_rank: Optional[float] = None - """exchange trust score rank""" + """Exchange trust score rank""" - twitter_handle: Optional[str] = None - """exchange twitter handle""" + twitter_handle: str + """Twitter handle""" - url: Optional[str] = None - """exchange website url""" + url: str + """Exchange website URL""" year_established: Optional[float] = None - """exchange established year""" + """Year the exchange was established""" diff --git a/src/coingecko_sdk/types/exchange_get_list_params.py b/src/coingecko_sdk/types/exchange_get_list_params.py index 2893b17..197a214 100644 --- a/src/coingecko_sdk/types/exchange_get_list_params.py +++ b/src/coingecko_sdk/types/exchange_get_list_params.py @@ -9,4 +9,4 @@ class ExchangeGetListParams(TypedDict, total=False): status: Literal["active", "inactive"] - """filter by status of exchanges, default: active""" + """Filter by status of exchanges. Default: `active`""" diff --git a/src/coingecko_sdk/types/exchange_get_list_response.py b/src/coingecko_sdk/types/exchange_get_list_response.py index 85f094e..1f0c41e 100644 --- a/src/coingecko_sdk/types/exchange_get_list_response.py +++ b/src/coingecko_sdk/types/exchange_get_list_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from typing_extensions import TypeAlias from .._models import BaseModel @@ -9,11 +9,11 @@ class ExchangeGetListResponseItem(BaseModel): - id: Optional[str] = None - """exchange ID""" + id: str + """Exchange ID""" - name: Optional[str] = None - """exchange name""" + name: str + """Exchange name""" ExchangeGetListResponse: TypeAlias = List[ExchangeGetListResponseItem] diff --git a/src/coingecko_sdk/types/exchange_get_params.py b/src/coingecko_sdk/types/exchange_get_params.py index e3ba2d0..8d40be5 100644 --- a/src/coingecko_sdk/types/exchange_get_params.py +++ b/src/coingecko_sdk/types/exchange_get_params.py @@ -9,7 +9,7 @@ class ExchangeGetParams(TypedDict, total=False): page: float - """page through results, default: 1""" + """Page through results. Default: 1""" per_page: float - """total results per page, default: 100 Valid values: 1...250""" + """Total results per page. Default: 100. Valid values: 1...250""" diff --git a/src/coingecko_sdk/types/exchange_get_response.py b/src/coingecko_sdk/types/exchange_get_response.py index 6deaed4..5a50a19 100644 --- a/src/coingecko_sdk/types/exchange_get_response.py +++ b/src/coingecko_sdk/types/exchange_get_response.py @@ -9,38 +9,38 @@ class ExchangeGetResponseItem(BaseModel): - id: Optional[str] = None - """exchange ID""" + id: str + """Exchange ID""" country: Optional[str] = None - """exchange country""" + """Country where the exchange is based""" - description: Optional[str] = None - """exchange description""" + description: str + """Exchange description""" - has_trading_incentive: Optional[bool] = None - """exchange trading incentive""" + has_trading_incentive: bool + """Whether the exchange has trading incentive""" - image: Optional[str] = None - """exchange image URL""" + image: str + """Exchange logo URL""" - name: Optional[str] = None - """exchange name""" + name: str + """Exchange name""" - trade_volume_24h_btc: Optional[float] = None - """exchange trade volume in BTC in 24 hours""" + trade_volume_24h_btc: float + """Exchange 24h trading volume in BTC""" trust_score: Optional[float] = None - """exchange trust score""" + """Exchange trust score""" trust_score_rank: Optional[float] = None - """exchange trust score rank""" + """Exchange trust score rank""" - url: Optional[str] = None - """exchange website URL""" + url: str + """Exchange website URL""" year_established: Optional[float] = None - """exchange established year""" + """Year the exchange was established""" ExchangeGetResponse: TypeAlias = List[ExchangeGetResponseItem] diff --git a/src/coingecko_sdk/types/exchange_rate_get_response.py b/src/coingecko_sdk/types/exchange_rate_get_response.py index 5fb9671..01c7806 100644 --- a/src/coingecko_sdk/types/exchange_rate_get_response.py +++ b/src/coingecko_sdk/types/exchange_rate_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import Dict, Optional +from typing import Dict from .._models import BaseModel @@ -8,18 +8,19 @@ class Rates(BaseModel): - name: Optional[str] = None - """name of the currency""" + name: str + """Currency name""" - type: Optional[str] = None - """type of the currency""" + type: str + """Currency type: crypto, fiat, or commodity""" - unit: Optional[str] = None - """unit of the currency""" + unit: str + """Currency unit symbol""" - value: Optional[float] = None - """value of the currency""" + value: float + """Exchange rate value relative to BTC""" class ExchangeRateGetResponse(BaseModel): - rates: Optional[Dict[str, Rates]] = None + rates: Dict[str, Rates] + """Exchange rates keyed by currency code""" diff --git a/src/coingecko_sdk/types/exchanges/ticker_get_params.py b/src/coingecko_sdk/types/exchanges/ticker_get_params.py index 244bfd7..87fa5e3 100644 --- a/src/coingecko_sdk/types/exchanges/ticker_get_params.py +++ b/src/coingecko_sdk/types/exchanges/ticker_get_params.py @@ -9,25 +9,25 @@ class TickerGetParams(TypedDict, total=False): coin_ids: str - """ - filter tickers by coin IDs, comma-separated if querying more than 1 coin + """Filter tickers by coin IDs, comma-separated if querying more than 1 coin. + \\**refers to [`/coins/list`](/reference/coins-list). """ depth: bool - """ - include 2% orderbook depth (Example: cost_to_move_up_usd & - cost_to_move_down_usd),default: false + """Include 2% orderbook depth (cost_to_move_up_usd and cost_to_move_down_usd). + + Default: false """ dex_pair_format: Literal["contract_address", "symbol"] - """ - set to `symbol` to display DEX pair base and target as symbols, default: - `contract_address` + """Set to `symbol` to display DEX pair base and target as symbols. + + Default: `contract_address` """ include_exchange_logo: bool - """include exchange logo, default: false""" + """Include exchange logo. Default: false""" order: Literal[ "market_cap_asc", @@ -38,7 +38,7 @@ class TickerGetParams(TypedDict, total=False): "volume_asc", "base_target", ] - """use this to sort the order of responses, default: trust_score_desc""" + """Sort the order of responses. Default: `trust_score_desc`""" page: float - """page through results""" + """Page through results.""" diff --git a/src/coingecko_sdk/types/exchanges/ticker_get_response.py b/src/coingecko_sdk/types/exchanges/ticker_get_response.py index 3059252..e614b51 100644 --- a/src/coingecko_sdk/types/exchanges/ticker_get_response.py +++ b/src/coingecko_sdk/types/exchanges/ticker_get_response.py @@ -8,7 +8,7 @@ class TickerConvertedLast(BaseModel): - """coin ticker converted last price""" + """Converted last price""" btc: Optional[float] = None @@ -18,7 +18,7 @@ class TickerConvertedLast(BaseModel): class TickerConvertedVolume(BaseModel): - """coin ticker converted volume""" + """Converted trading volume""" btc: Optional[float] = None @@ -28,89 +28,89 @@ class TickerConvertedVolume(BaseModel): class TickerMarket(BaseModel): - """coin ticker exchange""" + """Exchange information""" has_trading_incentive: Optional[bool] = None - """exchange trading incentive""" + """Exchange trading incentive""" identifier: Optional[str] = None - """exchange identifier""" + """Exchange identifier""" logo: Optional[str] = None - """exchange image url""" + """Exchange logo URL""" name: Optional[str] = None - """exchange name""" + """Exchange name""" class Ticker(BaseModel): - base: Optional[str] = None - """coin ticker base currency""" + base: str + """Ticker base currency""" - bid_ask_spread_percentage: Optional[float] = None - """coin ticker bid ask spread percentage""" + bid_ask_spread_percentage: float + """Bid-ask spread percentage""" - coin_id: Optional[str] = None - """coin ticker base currency coin ID""" + coin_id: str + """Base currency coin ID""" - coin_mcap_usd: Optional[float] = None - """coin market cap in usd""" + coin_mcap_usd: float + """Coin market cap in USD""" - converted_last: Optional[TickerConvertedLast] = None - """coin ticker converted last price""" + converted_last: TickerConvertedLast + """Converted last price""" - converted_volume: Optional[TickerConvertedVolume] = None - """coin ticker converted volume""" + converted_volume: TickerConvertedVolume + """Converted trading volume""" - cost_to_move_down_usd: Optional[float] = None - """coin ticker cost to move down in usd""" - - cost_to_move_up_usd: Optional[float] = None - """coin ticker cost to move up in usd""" + is_anomaly: bool + """Whether ticker is anomalous""" - is_anomaly: Optional[bool] = None - """coin ticker anomaly""" + is_stale: bool + """Whether ticker is stale""" - is_stale: Optional[bool] = None - """coin ticker stale""" + last: float + """Last price""" - last: Optional[float] = None - """coin ticker last price""" + last_fetch_at: str + """Last fetch timestamp""" - last_fetch_at: Optional[str] = None - """coin ticker last fetch timestamp""" + last_traded_at: str + """Last traded timestamp""" - last_traded_at: Optional[str] = None - """coin ticker last traded timestamp""" + market: TickerMarket + """Exchange information""" - market: Optional[TickerMarket] = None - """coin ticker exchange""" + target: str + """Ticker target currency""" - target: Optional[str] = None - """coin ticker target currency""" + target_coin_id: str + """Target currency coin ID""" - target_coin_id: Optional[str] = None - """coin ticker target currency coin ID""" - - timestamp: Optional[str] = None - """coin ticker timestamp""" + timestamp: str + """Ticker timestamp""" token_info_url: Optional[str] = None - """coin ticker token info url""" + """Token info URL""" - trade_url: Optional[str] = None - """coin ticker trade url""" + trade_url: str + """Trade URL""" trust_score: Optional[str] = None - """coin ticker trust score""" + """Trust score""" - volume: Optional[float] = None - """coin ticker volume""" + volume: float + """Trading volume""" + + cost_to_move_down_usd: Optional[float] = None + """Cost to move price down by 2% in USD""" + + cost_to_move_up_usd: Optional[float] = None + """Cost to move price up by 2% in USD""" class TickerGetResponse(BaseModel): - name: Optional[str] = None - """coin name""" + name: str + """Coin name""" - tickers: Optional[List[Ticker]] = None - """list of tickers""" + tickers: List[Ticker] + """List of tickers""" diff --git a/src/coingecko_sdk/types/exchanges/volume_chart_get_params.py b/src/coingecko_sdk/types/exchanges/volume_chart_get_params.py index 729bfb0..98960a1 100644 --- a/src/coingecko_sdk/types/exchanges/volume_chart_get_params.py +++ b/src/coingecko_sdk/types/exchanges/volume_chart_get_params.py @@ -9,4 +9,4 @@ class VolumeChartGetParams(TypedDict, total=False): days: Required[Literal["1", "7", "14", "30", "90", "180", "365"]] - """data up to number of days ago""" + """Data up to number of days ago.""" diff --git a/src/coingecko_sdk/types/exchanges/volume_chart_get_range_params.py b/src/coingecko_sdk/types/exchanges/volume_chart_get_range_params.py index 49884a4..3f82090 100644 --- a/src/coingecko_sdk/types/exchanges/volume_chart_get_range_params.py +++ b/src/coingecko_sdk/types/exchanges/volume_chart_get_range_params.py @@ -11,7 +11,7 @@ class VolumeChartGetRangeParams(TypedDict, total=False): from_: Required[Annotated[float, PropertyInfo(alias="from")]] - """starting date in UNIX timestamp""" + """Starting date in UNIX timestamp.""" to: Required[float] - """ending date in UNIX timestamp""" + """Ending date in UNIX timestamp.""" diff --git a/src/coingecko_sdk/types/global_/decentralized_finance_defi_get_response.py b/src/coingecko_sdk/types/global_/decentralized_finance_defi_get_response.py index 0f61a82..ab4466d 100644 --- a/src/coingecko_sdk/types/global_/decentralized_finance_defi_get_response.py +++ b/src/coingecko_sdk/types/global_/decentralized_finance_defi_get_response.py @@ -1,34 +1,32 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import Optional - from ..._models import BaseModel __all__ = ["DecentralizedFinanceDefiGetResponse", "Data"] class Data(BaseModel): - defi_dominance: Optional[str] = None - """defi dominance""" + defi_dominance: str + """DeFi dominance percentage""" - defi_market_cap: Optional[str] = None - """defi market cap""" + defi_market_cap: str + """DeFi market cap""" - defi_to_eth_ratio: Optional[str] = None - """defi to eth ratio""" + defi_to_eth_ratio: str + """DeFi to ETH ratio""" - eth_market_cap: Optional[str] = None - """eth market cap""" + eth_market_cap: str + """ETH market cap""" - top_coin_defi_dominance: Optional[float] = None - """defi top coin dominance""" + top_coin_defi_dominance: float + """DeFi top coin dominance percentage""" - top_coin_name: Optional[str] = None - """defi top coin name""" + top_coin_name: str + """DeFi top coin name""" - trading_volume_24h: Optional[str] = None - """defi trading volume in 24 hours""" + trading_volume_24h: str + """DeFi trading volume in 24 hours""" class DecentralizedFinanceDefiGetResponse(BaseModel): - data: Optional[Data] = None + data: Data diff --git a/src/coingecko_sdk/types/global_/market_cap_chart_get_params.py b/src/coingecko_sdk/types/global_/market_cap_chart_get_params.py index 6d7d055..1ec17dd 100644 --- a/src/coingecko_sdk/types/global_/market_cap_chart_get_params.py +++ b/src/coingecko_sdk/types/global_/market_cap_chart_get_params.py @@ -9,10 +9,11 @@ class MarketCapChartGetParams(TypedDict, total=False): days: Required[Literal["1", "7", "14", "30", "90", "180", "365", "max"]] - """data up to number of days ago Valid values: any integer""" + """Data up to number of days ago.""" vs_currency: str - """ - target currency of market cap, default: usd \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) + """Target currency of market cap. + + Default: `usd` \\**refers to + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). """ diff --git a/src/coingecko_sdk/types/global_/market_cap_chart_get_response.py b/src/coingecko_sdk/types/global_/market_cap_chart_get_response.py index 0c54129..dcbb57b 100644 --- a/src/coingecko_sdk/types/global_/market_cap_chart_get_response.py +++ b/src/coingecko_sdk/types/global_/market_cap_chart_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ..._models import BaseModel @@ -8,10 +8,12 @@ class MarketCapChart(BaseModel): - market_cap: Optional[List[List[float]]] = None + market_cap: List[List[float]] + """Market cap data as [timestamp, market_cap] pairs""" - volume: Optional[List[List[float]]] = None + volume: List[List[float]] + """Volume data as [timestamp, volume] pairs""" class MarketCapChartGetResponse(BaseModel): - market_cap_chart: Optional[MarketCapChart] = None + market_cap_chart: MarketCapChart diff --git a/src/coingecko_sdk/types/global_get_response.py b/src/coingecko_sdk/types/global_get_response.py index 62e3a77..8068c38 100644 --- a/src/coingecko_sdk/types/global_get_response.py +++ b/src/coingecko_sdk/types/global_get_response.py @@ -1,69 +1,46 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import Optional +from typing import Dict from .._models import BaseModel -__all__ = ["GlobalGetResponse", "Data", "DataMarketCapPercentage", "DataTotalMarketCap", "DataTotalVolume"] - - -class DataMarketCapPercentage(BaseModel): - """cryptocurrencies market cap percentage""" - - btc: Optional[float] = None - - eth: Optional[float] = None - - -class DataTotalMarketCap(BaseModel): - """cryptocurrencies total market cap""" - - btc: Optional[float] = None - - eth: Optional[float] = None - - -class DataTotalVolume(BaseModel): - """cryptocurrencies total volume""" - - btc: Optional[float] = None - - eth: Optional[float] = None +__all__ = ["GlobalGetResponse", "Data"] class Data(BaseModel): - active_cryptocurrencies: Optional[float] = None - """number of active cryptocurrencies""" + active_cryptocurrencies: int + """Number of active cryptocurrencies""" - ended_icos: Optional[float] = None - """number of ended icos""" + ended_icos: int + """Number of ended ICOs""" - market_cap_change_percentage_24h_usd: Optional[float] = None - """cryptocurrencies market cap change percentage in 24 hours in usd""" + market_cap_change_percentage_24h_usd: float + """Market cap change percentage in 24 hours in USD""" - market_cap_percentage: Optional[DataMarketCapPercentage] = None - """cryptocurrencies market cap percentage""" + market_cap_percentage: Dict[str, float] + """Market cap percentage by coin""" - markets: Optional[float] = None - """number of exchanges""" + markets: int + """Number of exchanges""" - ongoing_icos: Optional[float] = None - """number of ongoing icos""" + ongoing_icos: int + """Number of ongoing ICOs""" - total_market_cap: Optional[DataTotalMarketCap] = None - """cryptocurrencies total market cap""" + total_market_cap: Dict[str, float] + """Total cryptocurrency market cap by currency""" - total_volume: Optional[DataTotalVolume] = None - """cryptocurrencies total volume""" + total_volume: Dict[str, float] + """Total cryptocurrency volume by currency""" - upcoming_icos: Optional[float] = None - """number of upcoming icos""" + upcoming_icos: int + """Number of upcoming ICOs""" - updated_at: Optional[float] = None + updated_at: int + """Last updated time in UNIX timestamp""" - volume_change_percentage_24h_usd: Optional[float] = None - """cryptocurrencies volume change percentage in 24 hours in usd""" + volume_change_percentage_24h_usd: float + """Volume change percentage in 24 hours in USD""" class GlobalGetResponse(BaseModel): - data: Optional[Data] = None + data: Data diff --git a/src/coingecko_sdk/types/key_get_response.py b/src/coingecko_sdk/types/key_get_response.py index 0227be1..5001dd0 100644 --- a/src/coingecko_sdk/types/key_get_response.py +++ b/src/coingecko_sdk/types/key_get_response.py @@ -1,31 +1,31 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import Optional - from .._models import BaseModel __all__ = ["KeyGetResponse"] class KeyGetResponse(BaseModel): - api_key_monthly_call_credit: Optional[float] = None - """ - Specific monthly credit limit configured for the API key used to authenticate - this request - """ + api_key_current_total_monthly_calls: int + """Total API calls made this month by this API key""" + + api_key_monthly_call_credit: int + """Monthly call credit limit configured for this API key""" - api_key_rate_limit_request_per_minute: Optional[float] = None - """ - Specific request per minute configured for the API key used to authenticate this - request - """ + api_key_rate_limit_request_per_minute: int + """Rate limit per minute configured for this API key""" - current_remaining_monthly_calls: Optional[float] = None + current_remaining_monthly_calls: int + """Remaining API call credits this month""" - current_total_monthly_calls: Optional[float] = None + current_total_monthly_calls: int + """Total API calls made this month""" - monthly_call_credit: Optional[float] = None + monthly_call_credit: int + """Total monthly API call credits for the plan""" - plan: Optional[str] = None + plan: str + """Current subscription plan""" - rate_limit_request_per_minute: Optional[float] = None + rate_limit_request_per_minute: int + """Rate limit per minute for the plan""" diff --git a/src/coingecko_sdk/types/news_get_params.py b/src/coingecko_sdk/types/news_get_params.py index 734b738..e1308b5 100644 --- a/src/coingecko_sdk/types/news_get_params.py +++ b/src/coingecko_sdk/types/news_get_params.py @@ -9,7 +9,7 @@ class NewsGetParams(TypedDict, total=False): coin_id: str - """filter news by coin ID \\**refers to [`/coins/list`](/reference/coins-list).""" + """Filter news by coin ID. \\**refers to [`/coins/list`](/reference/coins-list).""" language: Literal[ "en", @@ -47,16 +47,17 @@ class NewsGetParams(TypedDict, total=False): "zh", "zh-tw", ] - """filter news by language Default value: **en**""" + """Filter news by language. Default: `en`""" page: int - """page through results Default value: **1**""" + """Page through results. Default value: 1 Valid values: 1...20""" per_page: int - """total results per page Default value: **10**""" + """Total results per page. Default value: 10 Valid values: 1...20""" type: Literal["all", "news", "guides"] - """ - filter news by type Default value: **all** Note: `guides` filter is only - applicable if `coin_id` is specified and valid + """Filter news by type. + + Default: `all` Note: `guides` filter is only applicable if `coin_id` is + specified and valid. """ diff --git a/src/coingecko_sdk/types/news_get_response.py b/src/coingecko_sdk/types/news_get_response.py index e242a8c..ee66a56 100644 --- a/src/coingecko_sdk/types/news_get_response.py +++ b/src/coingecko_sdk/types/news_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from typing_extensions import Literal, TypeAlias from .._models import BaseModel @@ -9,29 +9,29 @@ class NewsGetResponseItem(BaseModel): - author: Optional[str] = None - """news article author""" + author: str + """News article author""" - image: Optional[str] = None - """news article image URL""" + image: str + """News article image URL""" - posted_at: Optional[str] = None - """news article published timestamp in ISO 8601 format""" + posted_at: str + """News article published timestamp in ISO 8601 format""" - related_coin_ids: Optional[List[str]] = None - """related coin IDs""" + related_coin_ids: List[str] + """Related coin IDs""" - source_name: Optional[str] = None - """news article source name""" + source_name: str + """News article source name""" - title: Optional[str] = None - """news article title""" + title: str + """News article title""" - type: Optional[Literal["news", "guide"]] = None - """news article type""" + type: Literal["news", "guide"] + """News article type""" - url: Optional[str] = None - """news article URL""" + url: str + """News article URL""" NewsGetResponse: TypeAlias = List[NewsGetResponseItem] diff --git a/src/coingecko_sdk/types/nft_get_id_response.py b/src/coingecko_sdk/types/nft_get_id_response.py index f2c29c7..c11c779 100644 --- a/src/coingecko_sdk/types/nft_get_id_response.py +++ b/src/coingecko_sdk/types/nft_get_id_response.py @@ -82,6 +82,8 @@ class FloorPrice1yPercentageChange(BaseModel): class FloorPrice24hPercentageChange(BaseModel): + """NFT collection floor price 24 hours percentage change""" + native_currency: Optional[float] = None usd: Optional[float] = None @@ -112,7 +114,7 @@ class FloorPrice7dPercentageChange(BaseModel): class Image(BaseModel): - """NFT collection image url""" + """NFT collection image URLs""" small: Optional[str] = None @@ -162,115 +164,116 @@ class Volume24hPercentageChange(BaseModel): class NFTGetIDResponse(BaseModel): - id: Optional[str] = None + id: str """NFT collection ID""" - asset_platform_id: Optional[str] = None + asset_platform_id: str """NFT collection asset platform ID""" - ath: Optional[Ath] = None + ath: Ath """NFT collection all time highs""" - ath_change_percentage: Optional[AthChangePercentage] = None + ath_change_percentage: AthChangePercentage """NFT collection all time highs change percentage""" - ath_date: Optional[AthDate] = None + ath_date: AthDate """NFT collection all time highs date""" - banner_image: Optional[str] = None - """NFT collection banner image url""" + banner_image: str + """NFT collection banner image URL""" - contract_address: Optional[str] = None + contract_address: str """NFT collection contract address""" - description: Optional[str] = None + description: str """NFT collection description""" - explorers: Optional[List[Explorer]] = None - """NFT collection block explorers links""" + explorers: List[Explorer] + """NFT collection block explorer links""" - floor_price: Optional[FloorPrice] = None + floor_price: FloorPrice """NFT collection floor price""" - floor_price_14d_percentage_change: Optional[FloorPrice14dPercentageChange] = None + floor_price_14d_percentage_change: FloorPrice14dPercentageChange """NFT collection floor price 14 days percentage change""" - floor_price_1y_percentage_change: Optional[FloorPrice1yPercentageChange] = None + floor_price_1y_percentage_change: FloorPrice1yPercentageChange """NFT collection floor price 1 year percentage change""" - floor_price_24h_percentage_change: Optional[FloorPrice24hPercentageChange] = None + floor_price_24h_percentage_change: FloorPrice24hPercentageChange + """NFT collection floor price 24 hours percentage change""" - floor_price_30d_percentage_change: Optional[FloorPrice30dPercentageChange] = None + floor_price_30d_percentage_change: FloorPrice30dPercentageChange """NFT collection floor price 30 days percentage change""" - floor_price_60d_percentage_change: Optional[FloorPrice60dPercentageChange] = None + floor_price_60d_percentage_change: FloorPrice60dPercentageChange """NFT collection floor price 60 days percentage change""" - floor_price_7d_percentage_change: Optional[FloorPrice7dPercentageChange] = None + floor_price_7d_percentage_change: FloorPrice7dPercentageChange """NFT collection floor price 7 days percentage change""" - floor_price_in_usd_24h_percentage_change: Optional[float] = None - """NFT collection floor price in usd 24 hours percentage change""" + floor_price_in_usd_24h_percentage_change: float + """NFT collection floor price in USD 24 hours percentage change""" - image: Optional[Image] = None - """NFT collection image url""" + image: Image + """NFT collection image URLs""" - links: Optional[Links] = None + links: Links """NFT collection links""" - market_cap: Optional[MarketCap] = None + market_cap: MarketCap """NFT collection market cap""" - market_cap_24h_percentage_change: Optional[MarketCap24hPercentageChange] = None + market_cap_24h_percentage_change: MarketCap24hPercentageChange """NFT collection market cap 24 hours percentage change""" - market_cap_rank: Optional[float] = None - """coin market cap rank""" + market_cap_rank: Optional[int] = None + """NFT collection market cap rank""" - name: Optional[str] = None + name: str """NFT collection name""" - native_currency: Optional[str] = None + native_currency: str """NFT collection native currency""" - native_currency_symbol: Optional[str] = None + native_currency_symbol: str """NFT collection native currency symbol""" - number_of_unique_addresses: Optional[float] = None - """number of unique address owning the NFTs""" + number_of_unique_addresses: float + """Number of unique addresses owning the NFTs""" - number_of_unique_addresses_24h_percentage_change: Optional[float] = None - """number of unique address owning the NFTs 24 hours percentage change""" + number_of_unique_addresses_24h_percentage_change: float + """Number of unique addresses 24 hours percentage change""" one_day_average_sale_price: Optional[float] = None """NFT collection one day average sale price""" - one_day_average_sale_price_24h_percentage_change: Optional[float] = None + one_day_average_sale_price_24h_percentage_change: float """NFT collection one day average sale price 24 hours percentage change""" one_day_sales: Optional[float] = None """NFT collection one day sales""" - one_day_sales_24h_percentage_change: Optional[float] = None + one_day_sales_24h_percentage_change: float """NFT collection one day sales 24 hours percentage change""" - symbol: Optional[str] = None + symbol: str """NFT collection symbol""" - total_supply: Optional[float] = None + total_supply: float """NFT collection total supply""" - user_favorites_count: Optional[float] = None + user_favorites_count: int """NFT collection user favorites count""" - volume_24h: Optional[Volume24h] = None + volume_24h: Volume24h """NFT collection volume in 24 hours""" - volume_24h_percentage_change: Optional[Volume24hPercentageChange] = None + volume_24h_percentage_change: Volume24hPercentageChange """NFT collection volume in 24 hours percentage change""" - volume_in_usd_24h_percentage_change: Optional[float] = None - """NFT collection volume in usd 24 hours percentage change""" + volume_in_usd_24h_percentage_change: float + """NFT collection volume in USD 24 hours percentage change""" - web_slug: Optional[str] = None + web_slug: str """NFT collection web slug""" diff --git a/src/coingecko_sdk/types/nft_get_list_params.py b/src/coingecko_sdk/types/nft_get_list_params.py index 3700134..f354529 100644 --- a/src/coingecko_sdk/types/nft_get_list_params.py +++ b/src/coingecko_sdk/types/nft_get_list_params.py @@ -20,10 +20,10 @@ class NFTGetListParams(TypedDict, total=False): "market_cap_usd_asc", "market_cap_usd_desc", ] - """use this to sort the order of responses""" + """Sort order of responses.""" - page: float - """page through results""" + page: int + """Page through results.""" - per_page: float - """total results per page Valid values: 1...250""" + per_page: int + """Total results per page. Valid values: 1...250""" diff --git a/src/coingecko_sdk/types/nft_get_list_response.py b/src/coingecko_sdk/types/nft_get_list_response.py index 37d0f7d..ce48abf 100644 --- a/src/coingecko_sdk/types/nft_get_list_response.py +++ b/src/coingecko_sdk/types/nft_get_list_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from typing_extensions import TypeAlias from .._models import BaseModel @@ -9,19 +9,19 @@ class NFTGetListResponseItem(BaseModel): - id: Optional[str] = None + id: str """NFT collection ID""" - asset_platform_id: Optional[str] = None + asset_platform_id: str """NFT collection asset platform ID""" - contract_address: Optional[str] = None + contract_address: str """NFT collection contract address""" - name: Optional[str] = None + name: str """NFT collection name""" - symbol: Optional[str] = None + symbol: str """NFT collection symbol""" diff --git a/src/coingecko_sdk/types/nft_get_markets_params.py b/src/coingecko_sdk/types/nft_get_markets_params.py index 7aa1944..2809aca 100644 --- a/src/coingecko_sdk/types/nft_get_markets_params.py +++ b/src/coingecko_sdk/types/nft_get_markets_params.py @@ -9,9 +9,9 @@ class NFTGetMarketsParams(TypedDict, total=False): asset_platform_id: str - """ - filter result by asset platform (blockchain network) \\**refers to - [`/asset_platforms`](/reference/asset-platforms-list) filter=`nft` + """Filter result by asset platform (blockchain network). + + \\**refers to [`/asset_platforms`](/reference/asset-platforms-list) filter=`nft`. """ order: Literal[ @@ -22,13 +22,10 @@ class NFTGetMarketsParams(TypedDict, total=False): "market_cap_usd_asc", "market_cap_usd_desc", ] - """sort results by field Default: `market_cap_usd_desc`""" + """Sort results by field. Default: `market_cap_usd_desc`""" - page: float - """page through results Default: `1`""" + page: int + """Page through results. Default value: 1""" - per_page: float - """ - total results per page Valid values: any integer between 1 and 250 Default: - `100` - """ + per_page: int + """Total results per page. Default value: 100 Valid values: 1...250""" diff --git a/src/coingecko_sdk/types/nft_get_markets_response.py b/src/coingecko_sdk/types/nft_get_markets_response.py index fd4100d..df5b25d 100644 --- a/src/coingecko_sdk/types/nft_get_markets_response.py +++ b/src/coingecko_sdk/types/nft_get_markets_response.py @@ -35,7 +35,7 @@ class NFTGetMarketsResponseItemFloorPrice24hPercentageChange(BaseModel): class NFTGetMarketsResponseItemImage(BaseModel): - """NFT collection image url""" + """NFT collection image URLs""" small: Optional[str] = None @@ -75,10 +75,10 @@ class NFTGetMarketsResponseItemVolume24hPercentageChange(BaseModel): class NFTGetMarketsResponseItem(BaseModel): - id: Optional[str] = None + id: str """NFT collection ID""" - asset_platform_id: Optional[str] = None + asset_platform_id: str """NFT collection asset platform ID""" contract_address: Optional[str] = None @@ -87,68 +87,65 @@ class NFTGetMarketsResponseItem(BaseModel): description: Optional[str] = None """NFT collection description""" - floor_price: Optional[NFTGetMarketsResponseItemFloorPrice] = None + floor_price: NFTGetMarketsResponseItemFloorPrice """NFT collection floor price""" - floor_price_24h_percentage_change: Optional[NFTGetMarketsResponseItemFloorPrice24hPercentageChange] = None + floor_price_24h_percentage_change: NFTGetMarketsResponseItemFloorPrice24hPercentageChange """NFT collection floor price 24 hours percentage change""" - floor_price_in_usd_24h_percentage_change: Optional[float] = None - """NFT collection floor price in usd 24 hours percentage change""" + floor_price_in_usd_24h_percentage_change: float + """NFT collection floor price in USD 24 hours percentage change""" - image: Optional[NFTGetMarketsResponseItemImage] = None - """NFT collection image url""" + image: NFTGetMarketsResponseItemImage + """NFT collection image URLs""" - market_cap: Optional[NFTGetMarketsResponseItemMarketCap] = None + market_cap: NFTGetMarketsResponseItemMarketCap """NFT collection market cap""" - market_cap_24h_percentage_change: Optional[NFTGetMarketsResponseItemMarketCap24hPercentageChange] = None + market_cap_24h_percentage_change: NFTGetMarketsResponseItemMarketCap24hPercentageChange """NFT collection market cap 24 hours percentage change""" - market_cap_rank: Optional[float] = None - """coin market cap rank""" - - name: Optional[str] = None + name: str """NFT collection name""" - native_currency: Optional[str] = None + native_currency: str """NFT collection native currency""" - native_currency_symbol: Optional[str] = None + native_currency_symbol: str """NFT collection native currency symbol""" number_of_unique_addresses: Optional[float] = None - """number of unique address owning the NFTs""" + """Number of unique addresses owning the NFTs""" - number_of_unique_addresses_24h_percentage_change: Optional[float] = None - """number of unique address owning the NFTs 24 hours percentage change""" + number_of_unique_addresses_24h_percentage_change: float + """Number of unique addresses 24 hours percentage change""" one_day_average_sale_price: Optional[float] = None """NFT collection one day average sale price""" - one_day_average_sale_price_24h_percentage_change: Optional[float] = None + one_day_average_sale_price_24h_percentage_change: float """NFT collection one day average sale price 24 hours percentage change""" one_day_sales: Optional[float] = None """NFT collection one day sales""" - one_day_sales_24h_percentage_change: Optional[float] = None + one_day_sales_24h_percentage_change: float """NFT collection one day sales 24 hours percentage change""" - symbol: Optional[str] = None + symbol: str """NFT collection symbol""" total_supply: Optional[float] = None """NFT collection total supply""" - volume_24h: Optional[NFTGetMarketsResponseItemVolume24h] = None + volume_24h: NFTGetMarketsResponseItemVolume24h """NFT collection volume in 24 hours""" - volume_24h_percentage_change: Optional[NFTGetMarketsResponseItemVolume24hPercentageChange] = None + volume_24h_percentage_change: NFTGetMarketsResponseItemVolume24hPercentageChange """NFT collection volume in 24 hours percentage change""" - volume_in_usd_24h_percentage_change: Optional[float] = None - """NFT collection volume in usd 24 hours percentage change""" + volume_in_usd_24h_percentage_change: float + """NFT collection volume in USD 24 hours percentage change""" NFTGetMarketsResponse: TypeAlias = List[NFTGetMarketsResponseItem] diff --git a/src/coingecko_sdk/types/nfts/contract/market_chart_get_params.py b/src/coingecko_sdk/types/nfts/contract/market_chart_get_params.py index 0ccdc54..de3a031 100644 --- a/src/coingecko_sdk/types/nfts/contract/market_chart_get_params.py +++ b/src/coingecko_sdk/types/nfts/contract/market_chart_get_params.py @@ -11,4 +11,4 @@ class MarketChartGetParams(TypedDict, total=False): asset_platform_id: Required[str] days: Required[str] - """data up to number of days ago Valid values: any integer or max""" + """Data up to number of days ago. Valid values: any integer or `max`""" diff --git a/src/coingecko_sdk/types/nfts/contract/market_chart_get_response.py b/src/coingecko_sdk/types/nfts/contract/market_chart_get_response.py index 694864d..dd49d34 100644 --- a/src/coingecko_sdk/types/nfts/contract/market_chart_get_response.py +++ b/src/coingecko_sdk/types/nfts/contract/market_chart_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ...._models import BaseModel @@ -8,20 +8,20 @@ class MarketChartGetResponse(BaseModel): - floor_price_native: Optional[List[List[float]]] = None - """NFT collection floor price in native currency""" + floor_price_native: List[List[float]] + """NFT collection floor price in native currency as [timestamp, price] pairs""" - floor_price_usd: Optional[List[List[float]]] = None - """NFT collection floor price in usd""" + floor_price_usd: List[List[float]] + """NFT collection floor price in USD as [timestamp, price] pairs""" - h24_volume_native: Optional[List[List[float]]] = None - """NFT collection volume in 24 hours in native currency""" + h24_volume_native: List[List[float]] + """NFT collection 24h volume in native currency as [timestamp, volume] pairs""" - h24_volume_usd: Optional[List[List[float]]] = None - """NFT collection volume in 24 hours in usd""" + h24_volume_usd: List[List[float]] + """NFT collection 24h volume in USD as [timestamp, volume] pairs""" - market_cap_native: Optional[List[List[float]]] = None - """NFT collection market cap in native currency""" + market_cap_native: List[List[float]] + """NFT collection market cap in native currency as [timestamp, market_cap] pairs""" - market_cap_usd: Optional[List[List[float]]] = None - """NFT collection market cap in usd""" + market_cap_usd: List[List[float]] + """NFT collection market cap in USD as [timestamp, market_cap] pairs""" diff --git a/src/coingecko_sdk/types/nfts/contract_get_contract_address_response.py b/src/coingecko_sdk/types/nfts/contract_get_contract_address_response.py index fbd8f22..d4b9750 100644 --- a/src/coingecko_sdk/types/nfts/contract_get_contract_address_response.py +++ b/src/coingecko_sdk/types/nfts/contract_get_contract_address_response.py @@ -82,6 +82,8 @@ class FloorPrice1yPercentageChange(BaseModel): class FloorPrice24hPercentageChange(BaseModel): + """NFT collection floor price 24 hours percentage change""" + native_currency: Optional[float] = None usd: Optional[float] = None @@ -112,7 +114,7 @@ class FloorPrice7dPercentageChange(BaseModel): class Image(BaseModel): - """NFT collection image url""" + """NFT collection image URLs""" small: Optional[str] = None @@ -162,115 +164,116 @@ class Volume24hPercentageChange(BaseModel): class ContractGetContractAddressResponse(BaseModel): - id: Optional[str] = None + id: str """NFT collection ID""" - asset_platform_id: Optional[str] = None + asset_platform_id: str """NFT collection asset platform ID""" - ath: Optional[Ath] = None + ath: Ath """NFT collection all time highs""" - ath_change_percentage: Optional[AthChangePercentage] = None + ath_change_percentage: AthChangePercentage """NFT collection all time highs change percentage""" - ath_date: Optional[AthDate] = None + ath_date: AthDate """NFT collection all time highs date""" - banner_image: Optional[str] = None - """NFT collection banner image url""" + banner_image: str + """NFT collection banner image URL""" - contract_address: Optional[str] = None + contract_address: str """NFT collection contract address""" - description: Optional[str] = None + description: str """NFT collection description""" - explorers: Optional[List[Explorer]] = None - """NFT collection block explorers links""" + explorers: List[Explorer] + """NFT collection block explorer links""" - floor_price: Optional[FloorPrice] = None + floor_price: FloorPrice """NFT collection floor price""" - floor_price_14d_percentage_change: Optional[FloorPrice14dPercentageChange] = None + floor_price_14d_percentage_change: FloorPrice14dPercentageChange """NFT collection floor price 14 days percentage change""" - floor_price_1y_percentage_change: Optional[FloorPrice1yPercentageChange] = None + floor_price_1y_percentage_change: FloorPrice1yPercentageChange """NFT collection floor price 1 year percentage change""" - floor_price_24h_percentage_change: Optional[FloorPrice24hPercentageChange] = None + floor_price_24h_percentage_change: FloorPrice24hPercentageChange + """NFT collection floor price 24 hours percentage change""" - floor_price_30d_percentage_change: Optional[FloorPrice30dPercentageChange] = None + floor_price_30d_percentage_change: FloorPrice30dPercentageChange """NFT collection floor price 30 days percentage change""" - floor_price_60d_percentage_change: Optional[FloorPrice60dPercentageChange] = None + floor_price_60d_percentage_change: FloorPrice60dPercentageChange """NFT collection floor price 60 days percentage change""" - floor_price_7d_percentage_change: Optional[FloorPrice7dPercentageChange] = None + floor_price_7d_percentage_change: FloorPrice7dPercentageChange """NFT collection floor price 7 days percentage change""" - floor_price_in_usd_24h_percentage_change: Optional[float] = None - """NFT collection floor price in usd 24 hours percentage change""" + floor_price_in_usd_24h_percentage_change: float + """NFT collection floor price in USD 24 hours percentage change""" - image: Optional[Image] = None - """NFT collection image url""" + image: Image + """NFT collection image URLs""" - links: Optional[Links] = None + links: Links """NFT collection links""" - market_cap: Optional[MarketCap] = None + market_cap: MarketCap """NFT collection market cap""" - market_cap_24h_percentage_change: Optional[MarketCap24hPercentageChange] = None + market_cap_24h_percentage_change: MarketCap24hPercentageChange """NFT collection market cap 24 hours percentage change""" - market_cap_rank: Optional[float] = None - """coin market cap rank""" + market_cap_rank: Optional[int] = None + """NFT collection market cap rank""" - name: Optional[str] = None + name: str """NFT collection name""" - native_currency: Optional[str] = None + native_currency: str """NFT collection native currency""" - native_currency_symbol: Optional[str] = None + native_currency_symbol: str """NFT collection native currency symbol""" - number_of_unique_addresses: Optional[float] = None - """number of unique address owning the NFTs""" + number_of_unique_addresses: float + """Number of unique addresses owning the NFTs""" - number_of_unique_addresses_24h_percentage_change: Optional[float] = None - """number of unique address owning the NFTs 24 hours percentage change""" + number_of_unique_addresses_24h_percentage_change: float + """Number of unique addresses 24 hours percentage change""" one_day_average_sale_price: Optional[float] = None """NFT collection one day average sale price""" - one_day_average_sale_price_24h_percentage_change: Optional[float] = None + one_day_average_sale_price_24h_percentage_change: float """NFT collection one day average sale price 24 hours percentage change""" one_day_sales: Optional[float] = None """NFT collection one day sales""" - one_day_sales_24h_percentage_change: Optional[float] = None + one_day_sales_24h_percentage_change: float """NFT collection one day sales 24 hours percentage change""" - symbol: Optional[str] = None + symbol: str """NFT collection symbol""" - total_supply: Optional[float] = None + total_supply: float """NFT collection total supply""" - user_favorites_count: Optional[float] = None + user_favorites_count: int """NFT collection user favorites count""" - volume_24h: Optional[Volume24h] = None + volume_24h: Volume24h """NFT collection volume in 24 hours""" - volume_24h_percentage_change: Optional[Volume24hPercentageChange] = None + volume_24h_percentage_change: Volume24hPercentageChange """NFT collection volume in 24 hours percentage change""" - volume_in_usd_24h_percentage_change: Optional[float] = None - """NFT collection volume in usd 24 hours percentage change""" + volume_in_usd_24h_percentage_change: float + """NFT collection volume in USD 24 hours percentage change""" - web_slug: Optional[str] = None + web_slug: str """NFT collection web slug""" diff --git a/src/coingecko_sdk/types/nfts/market_chart_get_params.py b/src/coingecko_sdk/types/nfts/market_chart_get_params.py index ebab439..a6f4d74 100644 --- a/src/coingecko_sdk/types/nfts/market_chart_get_params.py +++ b/src/coingecko_sdk/types/nfts/market_chart_get_params.py @@ -9,4 +9,4 @@ class MarketChartGetParams(TypedDict, total=False): days: Required[str] - """data up to number of days Valid values: any integer or max""" + """Data up to number of days ago. Valid values: any integer or `max`""" diff --git a/src/coingecko_sdk/types/nfts/market_chart_get_response.py b/src/coingecko_sdk/types/nfts/market_chart_get_response.py index 9a5ca9a..36d9f6d 100644 --- a/src/coingecko_sdk/types/nfts/market_chart_get_response.py +++ b/src/coingecko_sdk/types/nfts/market_chart_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ..._models import BaseModel @@ -8,20 +8,20 @@ class MarketChartGetResponse(BaseModel): - floor_price_native: Optional[List[List[float]]] = None - """NFT collection floor price in native currency""" + floor_price_native: List[List[float]] + """NFT collection floor price in native currency as [timestamp, price] pairs""" - floor_price_usd: Optional[List[List[float]]] = None - """NFT collection floor price in usd""" + floor_price_usd: List[List[float]] + """NFT collection floor price in USD as [timestamp, price] pairs""" - h24_volume_native: Optional[List[List[float]]] = None - """NFT collection volume in 24 hours in native currency""" + h24_volume_native: List[List[float]] + """NFT collection 24h volume in native currency as [timestamp, volume] pairs""" - h24_volume_usd: Optional[List[List[float]]] = None - """NFT collection volume in 24 hours in usd""" + h24_volume_usd: List[List[float]] + """NFT collection 24h volume in USD as [timestamp, volume] pairs""" - market_cap_native: Optional[List[List[float]]] = None - """NFT collection market cap in native currency""" + market_cap_native: List[List[float]] + """NFT collection market cap in native currency as [timestamp, market_cap] pairs""" - market_cap_usd: Optional[List[List[float]]] = None - """NFT collection market cap in usd""" + market_cap_usd: List[List[float]] + """NFT collection market cap in USD as [timestamp, market_cap] pairs""" diff --git a/src/coingecko_sdk/types/nfts/ticker_get_response.py b/src/coingecko_sdk/types/nfts/ticker_get_response.py index aa60c27..1159d27 100644 --- a/src/coingecko_sdk/types/nfts/ticker_get_response.py +++ b/src/coingecko_sdk/types/nfts/ticker_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ..._models import BaseModel @@ -8,33 +8,33 @@ class Ticker(BaseModel): - floor_price_in_native_currency: Optional[float] = None + floor_price_in_native_currency: float """NFT collection floor price in native currency""" - h24_volume_in_native_currency: Optional[float] = None + h24_volume_in_native_currency: float """NFT collection volume in 24 hours in native currency""" - image: Optional[str] = None - """NFT marketplace image url""" + image: str + """NFT marketplace image URL""" - name: Optional[str] = None + name: str """NFT marketplace name""" - native_currency: Optional[str] = None + native_currency: str """NFT collection native currency""" - native_currency_symbol: Optional[str] = None + native_currency_symbol: str """NFT collection native currency symbol""" - nft_collection_url: Optional[str] = None - """NFT collection url in the NFT marketplace""" + nft_collection_url: str + """NFT collection URL in the NFT marketplace""" - nft_marketplace_id: Optional[str] = None + nft_marketplace_id: str """NFT marketplace ID""" - updated_at: Optional[str] = None - """last updated time""" + updated_at: str + """Last updated time""" class TickerGetResponse(BaseModel): - tickers: Optional[List[Ticker]] = None + tickers: List[Ticker] diff --git a/src/coingecko_sdk/types/onchain/category_get_params.py b/src/coingecko_sdk/types/onchain/category_get_params.py index 7a2745e..fad6167 100644 --- a/src/coingecko_sdk/types/onchain/category_get_params.py +++ b/src/coingecko_sdk/types/onchain/category_get_params.py @@ -9,7 +9,7 @@ class CategoryGetParams(TypedDict, total=False): page: int - """page through results Default value: `1`""" + """Page through results. Default value: 1""" sort: Literal[ "h1_volume_percentage_desc", @@ -20,4 +20,4 @@ class CategoryGetParams(TypedDict, total=False): "fdv_usd_desc", "reserve_in_usd_desc", ] - """sort the categories by field Default value: `h6_volume_percentage_desc`""" + """Sort the categories by field. Default: `h6_volume_percentage_desc`""" diff --git a/src/coingecko_sdk/types/onchain/category_get_pools_params.py b/src/coingecko_sdk/types/onchain/category_get_pools_params.py index e8aed29..06d9eee 100644 --- a/src/coingecko_sdk/types/onchain/category_get_pools_params.py +++ b/src/coingecko_sdk/types/onchain/category_get_pools_params.py @@ -9,14 +9,13 @@ class CategoryGetPoolsParams(TypedDict, total=False): include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network`. Example: `base_token` or - `base_token,dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex`, `network` """ page: int - """page through results Default value: `1`""" + """Page through results. Default value: 1""" sort: Literal[ "m5_trending", @@ -28,4 +27,4 @@ class CategoryGetPoolsParams(TypedDict, total=False): "pool_created_at_desc", "h24_price_change_percentage_desc", ] - """sort the pools by field Default value: `pool_created_at_desc`""" + """Sort the pools by field. Default: `pool_created_at_desc`""" diff --git a/src/coingecko_sdk/types/onchain/category_get_pools_response.py b/src/coingecko_sdk/types/onchain/category_get_pools_response.py index 27923c6..0c298c6 100644 --- a/src/coingecko_sdk/types/onchain/category_get_pools_response.py +++ b/src/coingecko_sdk/types/onchain/category_get_pools_response.py @@ -1,7 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. from typing import List, Optional -from datetime import datetime from ..._models import BaseModel @@ -25,6 +24,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -39,35 +40,50 @@ class DataAttributesPriceChangePercentage(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" - h24_tx_count: Optional[int] = None + h24_tx_count: int + """24hr transaction count""" - h24_volume_usd: Optional[str] = None + h24_volume_usd: str + """24hr volume in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[datetime] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" class DataRelationshipsBaseTokenData(BaseModel): @@ -111,6 +127,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -121,18 +139,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -153,6 +176,7 @@ class Included(BaseModel): class CategoryGetPoolsResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/category_get_response.py b/src/coingecko_sdk/types/onchain/category_get_response.py index bf783df..f9ce5cf 100644 --- a/src/coingecko_sdk/types/onchain/category_get_response.py +++ b/src/coingecko_sdk/types/onchain/category_get_response.py @@ -8,6 +8,8 @@ class DataAttributesVolumeChangePercentage(BaseModel): + """Volume change percentage over various timeframes""" + h1: Optional[str] = None h12: Optional[str] = None @@ -18,28 +20,37 @@ class DataAttributesVolumeChangePercentage(BaseModel): class DataAttributes(BaseModel): - description: Optional[str] = None + description: str + """Category description""" - fdv_usd: Optional[str] = None + fdv_usd: str + """Fully diluted valuation in USD""" - h24_tx_count: Optional[int] = None + h24_tx_count: int + """24hr transaction count""" - h24_volume_usd: Optional[str] = None + h24_volume_usd: str + """24hr volume in USD""" - name: Optional[str] = None + name: str + """Category name""" - reserve_in_usd: Optional[str] = None + reserve_in_usd: str + """Total reserve in USD""" - volume_change_percentage: Optional[DataAttributesVolumeChangePercentage] = None + volume_change_percentage: DataAttributesVolumeChangePercentage + """Volume change percentage over various timeframes""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Category ID""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class CategoryGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] diff --git a/src/coingecko_sdk/types/onchain/network_get_params.py b/src/coingecko_sdk/types/onchain/network_get_params.py index e22e1d4..08cfce7 100644 --- a/src/coingecko_sdk/types/onchain/network_get_params.py +++ b/src/coingecko_sdk/types/onchain/network_get_params.py @@ -9,4 +9,4 @@ class NetworkGetParams(TypedDict, total=False): page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" diff --git a/src/coingecko_sdk/types/onchain/network_get_response.py b/src/coingecko_sdk/types/onchain/network_get_response.py index 39675c7..11b1998 100644 --- a/src/coingecko_sdk/types/onchain/network_get_response.py +++ b/src/coingecko_sdk/types/onchain/network_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ..._models import BaseModel @@ -8,18 +8,22 @@ class DataAttributes(BaseModel): - coingecko_asset_platform_id: Optional[str] = None + coingecko_asset_platform_id: str + """Corresponding CoinGecko asset platform ID""" - name: Optional[str] = None + name: str + """Network name""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Network identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class NetworkGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] diff --git a/src/coingecko_sdk/types/onchain/networks/__init__.py b/src/coingecko_sdk/types/onchain/networks/__init__.py index b48ec26..43412d5 100644 --- a/src/coingecko_sdk/types/onchain/networks/__init__.py +++ b/src/coingecko_sdk/types/onchain/networks/__init__.py @@ -2,10 +2,11 @@ from __future__ import annotations -from .pool_data import PoolData as PoolData +from .token_item import TokenItem as TokenItem from .dex_get_params import DexGetParams as DexGetParams from .pool_get_params import PoolGetParams as PoolGetParams from .dex_get_response import DexGetResponse as DexGetResponse +from .pool_address_item import PoolAddressItem as PoolAddressItem from .pool_get_response import PoolGetResponse as PoolGetResponse from .new_pool_get_params import NewPoolGetParams as NewPoolGetParams from .dex_get_pools_params import DexGetPoolsParams as DexGetPoolsParams diff --git a/src/coingecko_sdk/types/onchain/networks/dex_get_params.py b/src/coingecko_sdk/types/onchain/networks/dex_get_params.py index c4f2a44..d8334be 100644 --- a/src/coingecko_sdk/types/onchain/networks/dex_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/dex_get_params.py @@ -9,4 +9,4 @@ class DexGetParams(TypedDict, total=False): page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" diff --git a/src/coingecko_sdk/types/onchain/networks/dex_get_pools_params.py b/src/coingecko_sdk/types/onchain/networks/dex_get_pools_params.py index 54e17cd..e144c91 100644 --- a/src/coingecko_sdk/types/onchain/networks/dex_get_pools_params.py +++ b/src/coingecko_sdk/types/onchain/networks/dex_get_pools_params.py @@ -11,19 +11,19 @@ class DexGetPoolsParams(TypedDict, total=False): network: Required[str] include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex` """ include_gt_community_data: bool - """ - include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + """Include GeckoTerminal community data (sentiment votes, suspicious reports). + + Default: `false` """ page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" sort: Literal["h24_tx_count_desc", "h24_volume_usd_desc"] - """sort the pools by field Default value: h24_tx_count_desc""" + """Sort the pools by field. Default: `h24_tx_count_desc`""" diff --git a/src/coingecko_sdk/types/onchain/networks/dex_get_pools_response.py b/src/coingecko_sdk/types/onchain/networks/dex_get_pools_response.py index e317ca1..7924639 100644 --- a/src/coingecko_sdk/types/onchain/networks/dex_get_pools_response.py +++ b/src/coingecko_sdk/types/onchain/networks/dex_get_pools_response.py @@ -32,6 +32,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -106,6 +108,8 @@ class DataAttributesTransactionsM5(BaseModel): class DataAttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[DataAttributesTransactionsH1] = None h24: Optional[DataAttributesTransactionsH24] = None @@ -120,6 +124,8 @@ class DataAttributesTransactions(BaseModel): class DataAttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -134,41 +140,62 @@ class DataAttributesVolumeUsd(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None - - community_sus_report: Optional[float] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" + + transactions: DataAttributesTransactions + """Transaction counts over various timeframes""" + + volume_usd: DataAttributesVolumeUsd + """Volume in USD over various timeframes""" + + community_sus_report: Optional[int] = None + """GeckoTerminal community suspicious reports count""" sentiment_vote_negative_percentage: Optional[float] = None + """GeckoTerminal community negative sentiment vote percentage""" sentiment_vote_positive_percentage: Optional[float] = None + """GeckoTerminal community positive sentiment vote percentage""" - transactions: Optional[DataAttributesTransactions] = None - - volume_usd: Optional[DataAttributesVolumeUsd] = None + token_price_usd: Optional[str] = None + """Price of the queried token in USD, present when querying pools by token address""" class DataRelationshipsBaseTokenData(BaseModel): @@ -212,6 +239,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -222,18 +251,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -254,6 +288,7 @@ class Included(BaseModel): class DexGetPoolsResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/dex_get_response.py b/src/coingecko_sdk/types/onchain/networks/dex_get_response.py index 978fd78..27dc75e 100644 --- a/src/coingecko_sdk/types/onchain/networks/dex_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/dex_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ...._models import BaseModel @@ -8,16 +8,19 @@ class DataAttributes(BaseModel): - name: Optional[str] = None + name: str + """DEX name""" class Data(BaseModel): - id: Optional[str] = None + id: str + """DEX identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class DexGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] diff --git a/src/coingecko_sdk/types/onchain/networks/new_pool_get_network_params.py b/src/coingecko_sdk/types/onchain/networks/new_pool_get_network_params.py index c7f6994..7f2105d 100644 --- a/src/coingecko_sdk/types/onchain/networks/new_pool_get_network_params.py +++ b/src/coingecko_sdk/types/onchain/networks/new_pool_get_network_params.py @@ -9,16 +9,16 @@ class NewPoolGetNetworkParams(TypedDict, total=False): include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex` """ include_gt_community_data: bool - """ - include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + """Include GeckoTerminal community data (sentiment votes, suspicious reports). + + Default: `false` """ page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" diff --git a/src/coingecko_sdk/types/onchain/networks/new_pool_get_network_response.py b/src/coingecko_sdk/types/onchain/networks/new_pool_get_network_response.py index 1fc6192..660a71e 100644 --- a/src/coingecko_sdk/types/onchain/networks/new_pool_get_network_response.py +++ b/src/coingecko_sdk/types/onchain/networks/new_pool_get_network_response.py @@ -32,6 +32,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -106,6 +108,8 @@ class DataAttributesTransactionsM5(BaseModel): class DataAttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[DataAttributesTransactionsH1] = None h24: Optional[DataAttributesTransactionsH24] = None @@ -120,6 +124,8 @@ class DataAttributesTransactions(BaseModel): class DataAttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -134,41 +140,62 @@ class DataAttributesVolumeUsd(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None - - community_sus_report: Optional[float] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" + + transactions: DataAttributesTransactions + """Transaction counts over various timeframes""" + + volume_usd: DataAttributesVolumeUsd + """Volume in USD over various timeframes""" + + community_sus_report: Optional[int] = None + """GeckoTerminal community suspicious reports count""" sentiment_vote_negative_percentage: Optional[float] = None + """GeckoTerminal community negative sentiment vote percentage""" sentiment_vote_positive_percentage: Optional[float] = None + """GeckoTerminal community positive sentiment vote percentage""" - transactions: Optional[DataAttributesTransactions] = None - - volume_usd: Optional[DataAttributesVolumeUsd] = None + token_price_usd: Optional[str] = None + """Price of the queried token in USD, present when querying pools by token address""" class DataRelationshipsBaseTokenData(BaseModel): @@ -212,6 +239,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -222,18 +251,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -254,6 +288,7 @@ class Included(BaseModel): class NewPoolGetNetworkResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/new_pool_get_params.py b/src/coingecko_sdk/types/onchain/networks/new_pool_get_params.py index 82fbf88..fa5f8b8 100644 --- a/src/coingecko_sdk/types/onchain/networks/new_pool_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/new_pool_get_params.py @@ -9,16 +9,16 @@ class NewPoolGetParams(TypedDict, total=False): include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex`, `network` """ include_gt_community_data: bool - """ - include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + """Include GeckoTerminal community data (sentiment votes, suspicious reports). + + Default: `false` """ page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" diff --git a/src/coingecko_sdk/types/onchain/networks/new_pool_get_response.py b/src/coingecko_sdk/types/onchain/networks/new_pool_get_response.py index 6ad44f4..f603261 100644 --- a/src/coingecko_sdk/types/onchain/networks/new_pool_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/new_pool_get_response.py @@ -32,6 +32,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -106,6 +108,8 @@ class DataAttributesTransactionsM5(BaseModel): class DataAttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[DataAttributesTransactionsH1] = None h24: Optional[DataAttributesTransactionsH24] = None @@ -120,6 +124,8 @@ class DataAttributesTransactions(BaseModel): class DataAttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -134,41 +140,62 @@ class DataAttributesVolumeUsd(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None - - community_sus_report: Optional[float] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" + + transactions: DataAttributesTransactions + """Transaction counts over various timeframes""" + + volume_usd: DataAttributesVolumeUsd + """Volume in USD over various timeframes""" + + community_sus_report: Optional[int] = None + """GeckoTerminal community suspicious reports count""" sentiment_vote_negative_percentage: Optional[float] = None + """GeckoTerminal community negative sentiment vote percentage""" sentiment_vote_positive_percentage: Optional[float] = None + """GeckoTerminal community positive sentiment vote percentage""" - transactions: Optional[DataAttributesTransactions] = None - - volume_usd: Optional[DataAttributesVolumeUsd] = None + token_price_usd: Optional[str] = None + """Price of the queried token in USD, present when querying pools by token address""" class DataRelationshipsBaseTokenData(BaseModel): @@ -212,6 +239,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -222,18 +251,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -254,6 +288,7 @@ class Included(BaseModel): class NewPoolGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/pool_data.py b/src/coingecko_sdk/types/onchain/networks/pool_address_item.py similarity index 68% rename from src/coingecko_sdk/types/onchain/networks/pool_data.py rename to src/coingecko_sdk/types/onchain/networks/pool_address_item.py index 6db504e..942a0ee 100644 --- a/src/coingecko_sdk/types/onchain/networks/pool_data.py +++ b/src/coingecko_sdk/types/onchain/networks/pool_address_item.py @@ -5,12 +5,9 @@ from ...._models import BaseModel __all__ = [ - "PoolData", + "PoolAddressItem", "Attributes", - "AttributesBuyVolumeUsd", - "AttributesNetBuyVolumeUsd", "AttributesPriceChangePercentage", - "AttributesSellVolumeUsd", "AttributesTransactions", "AttributesTransactionsH1", "AttributesTransactionsH24", @@ -19,6 +16,9 @@ "AttributesTransactionsM30", "AttributesTransactionsM5", "AttributesVolumeUsd", + "AttributesBuyVolumeUsd", + "AttributesNetBuyVolumeUsd", + "AttributesSellVolumeUsd", "Relationships", "RelationshipsBaseToken", "RelationshipsBaseTokenData", @@ -29,49 +29,9 @@ ] -class AttributesBuyVolumeUsd(BaseModel): - h1: Optional[str] = None - - h24: Optional[str] = None - - h6: Optional[str] = None - - m15: Optional[str] = None - - m30: Optional[str] = None - - m5: Optional[str] = None - - -class AttributesNetBuyVolumeUsd(BaseModel): - h1: Optional[str] = None - - h24: Optional[str] = None - - h6: Optional[str] = None - - m15: Optional[str] = None - - m30: Optional[str] = None - - m5: Optional[str] = None - - class AttributesPriceChangePercentage(BaseModel): - h1: Optional[str] = None - - h24: Optional[str] = None - - h6: Optional[str] = None - - m15: Optional[str] = None - - m30: Optional[str] = None + """Price change percentage over various timeframes""" - m5: Optional[str] = None - - -class AttributesSellVolumeUsd(BaseModel): h1: Optional[str] = None h24: Optional[str] = None @@ -146,6 +106,8 @@ class AttributesTransactionsM5(BaseModel): class AttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[AttributesTransactionsH1] = None h24: Optional[AttributesTransactionsH24] = None @@ -160,6 +122,8 @@ class AttributesTransactions(BaseModel): class AttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -173,56 +137,129 @@ class AttributesVolumeUsd(BaseModel): m5: Optional[str] = None -class Attributes(BaseModel): - address: Optional[str] = None +class AttributesBuyVolumeUsd(BaseModel): + """Buy volume in USD over various timeframes""" - base_token_balance: Optional[str] = None + h1: Optional[str] = None - base_token_liquidity_usd: Optional[str] = None + h24: Optional[str] = None - base_token_price_native_currency: Optional[str] = None + h6: Optional[str] = None - base_token_price_quote_token: Optional[str] = None + m15: Optional[str] = None - base_token_price_usd: Optional[str] = None + m30: Optional[str] = None - buy_volume_usd: Optional[AttributesBuyVolumeUsd] = None + m5: Optional[str] = None + + +class AttributesNetBuyVolumeUsd(BaseModel): + """Net buy volume in USD over various timeframes""" + + h1: Optional[str] = None + + h24: Optional[str] = None + + h6: Optional[str] = None + + m15: Optional[str] = None + + m30: Optional[str] = None + + m5: Optional[str] = None + + +class AttributesSellVolumeUsd(BaseModel): + """Sell volume in USD over various timeframes""" + + h1: Optional[str] = None + + h24: Optional[str] = None + + h6: Optional[str] = None + + m15: Optional[str] = None + + m30: Optional[str] = None + + m5: Optional[str] = None + + +class Attributes(BaseModel): + address: str + """Pool contract address""" + + base_token_price_native_currency: str + """Base token price in native currency""" + + base_token_price_quote_token: str + """Base token price in quote token""" + + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" - locked_liquidity_percentage: Optional[str] = None + locked_liquidity_percentage: str + """Locked liquidity percentage""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name with fee tier""" - net_buy_volume_usd: Optional[AttributesNetBuyVolumeUsd] = None + pool_created_at: str + """Pool creation timestamp""" - pool_created_at: Optional[str] = None + pool_fee_percentage: str + """Pool fee percentage""" - pool_fee_percentage: Optional[str] = None + pool_name: str + """Pool name without fee tier""" - pool_name: Optional[str] = None + price_change_percentage: AttributesPriceChangePercentage + """Price change percentage over various timeframes""" - price_change_percentage: Optional[AttributesPriceChangePercentage] = None + quote_token_price_base_token: str + """Quote token price in base token""" - quote_token_balance: Optional[str] = None + quote_token_price_native_currency: str + """Quote token price in native currency""" - quote_token_liquidity_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" - quote_token_price_base_token: Optional[str] = None + reserve_in_usd: str + """Total reserve in USD""" - quote_token_price_native_currency: Optional[str] = None + transactions: AttributesTransactions + """Transaction counts over various timeframes""" - quote_token_price_usd: Optional[str] = None + volume_usd: AttributesVolumeUsd + """Volume in USD over various timeframes""" - reserve_in_usd: Optional[str] = None + base_token_balance: Optional[str] = None + """Base token balance in pool""" - sell_volume_usd: Optional[AttributesSellVolumeUsd] = None + base_token_liquidity_usd: Optional[str] = None + """Base token liquidity in USD""" + + buy_volume_usd: Optional[AttributesBuyVolumeUsd] = None + """Buy volume in USD over various timeframes""" + + net_buy_volume_usd: Optional[AttributesNetBuyVolumeUsd] = None + """Net buy volume in USD over various timeframes""" - transactions: Optional[AttributesTransactions] = None + quote_token_balance: Optional[str] = None + """Quote token balance in pool""" + + quote_token_liquidity_usd: Optional[str] = None + """Quote token liquidity in USD""" - volume_usd: Optional[AttributesVolumeUsd] = None + sell_volume_usd: Optional[AttributesSellVolumeUsd] = None + """Sell volume in USD over various timeframes""" class RelationshipsBaseTokenData(BaseModel): @@ -256,6 +293,8 @@ class RelationshipsQuoteToken(BaseModel): class Relationships(BaseModel): + """Related resources""" + base_token: Optional[RelationshipsBaseToken] = None dex: Optional[RelationshipsDex] = None @@ -263,11 +302,14 @@ class Relationships(BaseModel): quote_token: Optional[RelationshipsQuoteToken] = None -class PoolData(BaseModel): - id: Optional[str] = None +class PoolAddressItem(BaseModel): + id: str + """Pool identifier""" - attributes: Optional[Attributes] = None + attributes: Attributes - relationships: Optional[Relationships] = None + relationships: Relationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" diff --git a/src/coingecko_sdk/types/onchain/networks/pool_get_address_params.py b/src/coingecko_sdk/types/onchain/networks/pool_get_address_params.py index 2072234..fda9f88 100644 --- a/src/coingecko_sdk/types/onchain/networks/pool_get_address_params.py +++ b/src/coingecko_sdk/types/onchain/networks/pool_get_address_params.py @@ -11,13 +11,13 @@ class PoolGetAddressParams(TypedDict, total=False): network: Required[str] include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex` """ include_composition: bool - """include pool composition, default: false""" + """Include pool composition. Default: `false`""" include_volume_breakdown: bool - """include volume breakdown, default: false""" + """Include volume breakdown. Default: `false`""" diff --git a/src/coingecko_sdk/types/onchain/networks/pool_get_address_response.py b/src/coingecko_sdk/types/onchain/networks/pool_get_address_response.py index 81d7189..167c4b7 100644 --- a/src/coingecko_sdk/types/onchain/networks/pool_get_address_response.py +++ b/src/coingecko_sdk/types/onchain/networks/pool_get_address_response.py @@ -2,8 +2,8 @@ from typing import List, Optional -from .pool_data import PoolData from ...._models import BaseModel +from .pool_address_item import PoolAddressItem __all__ = ["PoolGetAddressResponse", "Included", "IncludedAttributes"] @@ -31,6 +31,7 @@ class Included(BaseModel): class PoolGetAddressResponse(BaseModel): - data: Optional[PoolData] = None + data: PoolAddressItem included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/pool_get_params.py b/src/coingecko_sdk/types/onchain/networks/pool_get_params.py index 75f0ec2..3a088bf 100644 --- a/src/coingecko_sdk/types/onchain/networks/pool_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/pool_get_params.py @@ -9,19 +9,19 @@ class PoolGetParams(TypedDict, total=False): include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex` """ include_gt_community_data: bool - """ - include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + """Include GeckoTerminal community data (sentiment votes, suspicious reports). + + Default: `false` """ page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" sort: Literal["h24_tx_count_desc", "h24_volume_usd_desc"] - """sort the pools by field Default value: h24_tx_count_desc""" + """Sort the pools by field. Default: `h24_tx_count_desc`""" diff --git a/src/coingecko_sdk/types/onchain/networks/pool_get_response.py b/src/coingecko_sdk/types/onchain/networks/pool_get_response.py index 7168c6d..27d44c1 100644 --- a/src/coingecko_sdk/types/onchain/networks/pool_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/pool_get_response.py @@ -32,6 +32,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -106,6 +108,8 @@ class DataAttributesTransactionsM5(BaseModel): class DataAttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[DataAttributesTransactionsH1] = None h24: Optional[DataAttributesTransactionsH24] = None @@ -120,6 +124,8 @@ class DataAttributesTransactions(BaseModel): class DataAttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -134,41 +140,62 @@ class DataAttributesVolumeUsd(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None - - community_sus_report: Optional[float] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" + + transactions: DataAttributesTransactions + """Transaction counts over various timeframes""" + + volume_usd: DataAttributesVolumeUsd + """Volume in USD over various timeframes""" + + community_sus_report: Optional[int] = None + """GeckoTerminal community suspicious reports count""" sentiment_vote_negative_percentage: Optional[float] = None + """GeckoTerminal community negative sentiment vote percentage""" sentiment_vote_positive_percentage: Optional[float] = None + """GeckoTerminal community positive sentiment vote percentage""" - transactions: Optional[DataAttributesTransactions] = None - - volume_usd: Optional[DataAttributesVolumeUsd] = None + token_price_usd: Optional[str] = None + """Price of the queried token in USD, present when querying pools by token address""" class DataRelationshipsBaseTokenData(BaseModel): @@ -212,6 +239,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -222,18 +251,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -254,6 +288,7 @@ class Included(BaseModel): class PoolGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/pools/info_get_params.py b/src/coingecko_sdk/types/onchain/networks/pools/info_get_params.py index c290d2a..57315d1 100644 --- a/src/coingecko_sdk/types/onchain/networks/pools/info_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/pools/info_get_params.py @@ -11,4 +11,4 @@ class InfoGetParams(TypedDict, total=False): network: Required[str] include: Literal["pool"] - """attributes to include""" + """Attributes to include.""" diff --git a/src/coingecko_sdk/types/onchain/networks/pools/info_get_response.py b/src/coingecko_sdk/types/onchain/networks/pools/info_get_response.py index 5343ac4..307fbe5 100644 --- a/src/coingecko_sdk/types/onchain/networks/pools/info_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/pools/info_get_response.py @@ -1,26 +1,27 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Union, Optional - -from pydantic import Field as FieldInfo +from typing import Dict, List, Union, Optional from ....._models import BaseModel __all__ = [ "InfoGetResponse", "Data", - "DataData", - "DataDataAttributes", - "DataDataAttributesGtScoreDetails", - "DataDataAttributesHolders", - "DataDataAttributesHoldersDistributionPercentage", - "DataDataAttributesImage", + "DataAttributes", + "DataAttributesGtScoreDetails", + "DataAttributesHolders", + "DataAttributesImage", + "DataRelationships", + "DataRelationshipsPool", + "DataRelationshipsPoolData", "Included", "IncludedAttributes", ] -class DataDataAttributesGtScoreDetails(BaseModel): +class DataAttributesGtScoreDetails(BaseModel): + """GeckoTerminal trust score breakdown""" + creation: Optional[float] = None holders: Optional[float] = None @@ -32,25 +33,25 @@ class DataDataAttributesGtScoreDetails(BaseModel): transaction: Optional[float] = None -class DataDataAttributesHoldersDistributionPercentage(BaseModel): - dist_11_30: Optional[str] = FieldInfo(alias="11_30", default=None) - - dist_31_50: Optional[str] = FieldInfo(alias="31_50", default=None) - - rest: Optional[str] = None - - top_10: Optional[str] = None +class DataAttributesHolders(BaseModel): + """Token holder information""" - -class DataDataAttributesHolders(BaseModel): count: Optional[int] = None + """Number of holders""" + + distribution_percentage: Optional[Dict[str, str]] = None + """Holder distribution percentage (keys vary by chain, e.g. - distribution_percentage: Optional[DataDataAttributesHoldersDistributionPercentage] = None + top_10, 11_30, 31_50, rest) + """ last_updated: Optional[str] = None + """Last updated timestamp""" -class DataDataAttributesImage(BaseModel): +class DataAttributesImage(BaseModel): + """Token image URLs in different sizes""" + large: Optional[str] = None small: Optional[str] = None @@ -58,76 +59,121 @@ class DataDataAttributesImage(BaseModel): thumb: Optional[str] = None -class DataDataAttributes(BaseModel): - address: Optional[str] = None +class DataAttributes(BaseModel): + address: str + """Token contract address""" - categories: Optional[List[str]] = None + categories: List[str] + """Token categories""" coingecko_coin_id: Optional[str] = None + """CoinGecko coin ID""" - decimals: Optional[int] = None + decimals: int + """Token decimals""" description: Optional[str] = None + """Token description""" discord_url: Optional[str] = None + """Discord URL""" farcaster_url: Optional[str] = None + """Farcaster URL""" freeze_authority: Optional[str] = None + """Freeze authority status""" - gt_category_ids: Optional[List[str]] = None + gt_category_ids: List[str] + """GeckoTerminal category IDs""" - gt_score: Optional[float] = None + gt_score: float + """GeckoTerminal trust score""" - gt_score_details: Optional[DataDataAttributesGtScoreDetails] = None + gt_score_details: DataAttributesGtScoreDetails + """GeckoTerminal trust score breakdown""" - gt_verified: Optional[bool] = None + gt_verified: bool + """Whether the token is verified on GeckoTerminal""" - holders: Optional[DataDataAttributesHolders] = None + holders: DataAttributesHolders + """Token holder information""" - image: Optional[DataDataAttributesImage] = None + image: DataAttributesImage + """Token image URLs in different sizes""" image_url: Optional[str] = None + """Token image URL""" - is_honeypot: Union[bool, str, None] = None + is_honeypot: Union[bool, str] + """Whether the token is a honeypot (boolean or 'unknown')""" mint_authority: Optional[str] = None + """Mint authority status""" - name: Optional[str] = None + name: str + """Token name""" - symbol: Optional[str] = None + symbol: str + """Token symbol""" telegram_handle: Optional[str] = None + """Telegram handle""" twitter_handle: Optional[str] = None + """Twitter handle""" - websites: Optional[List[str]] = None + websites: List[str] + """Token websites""" zora_url: Optional[str] = None + """Zora URL""" -class DataData(BaseModel): +class DataRelationshipsPoolData(BaseModel): id: Optional[str] = None - attributes: Optional[DataDataAttributes] = None - type: Optional[str] = None +class DataRelationshipsPool(BaseModel): + data: Optional[DataRelationshipsPoolData] = None + + +class DataRelationships(BaseModel): + pool: Optional[DataRelationshipsPool] = None + + class Data(BaseModel): - data: Optional[DataData] = None + id: str + """Token identifier""" + + attributes: DataAttributes + + relationships: DataRelationships + + type: str + """Resource type""" class IncludedAttributes(BaseModel): base_token_address: Optional[str] = None + """Base token contract address""" - community_sus_report: Optional[float] = None + community_sus_report: Optional[int] = None + """GeckoTerminal community suspicious reports count""" quote_token_address: Optional[str] = None + """Quote token contract address""" + + quote_token_addresses: Optional[List[str]] = None + """Quote token contract addresses, present for pools with more than 2 tokens""" sentiment_vote_negative_percentage: Optional[float] = None + """GeckoTerminal community negative sentiment vote percentage""" sentiment_vote_positive_percentage: Optional[float] = None + """GeckoTerminal community positive sentiment vote percentage""" class Included(BaseModel): @@ -139,6 +185,7 @@ class Included(BaseModel): class InfoGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included pool data, present when include=pool is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/pools/multi_get_addresses_params.py b/src/coingecko_sdk/types/onchain/networks/pools/multi_get_addresses_params.py index 729b5f4..44d7477 100644 --- a/src/coingecko_sdk/types/onchain/networks/pools/multi_get_addresses_params.py +++ b/src/coingecko_sdk/types/onchain/networks/pools/multi_get_addresses_params.py @@ -11,13 +11,13 @@ class MultiGetAddressesParams(TypedDict, total=False): network: Required[str] include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex` """ include_composition: bool - """include pool composition, default: false""" + """Include pool composition. Default: `false`""" include_volume_breakdown: bool - """include volume breakdown, default: false""" + """Include volume breakdown. Default: `false`""" diff --git a/src/coingecko_sdk/types/onchain/networks/pools/multi_get_addresses_response.py b/src/coingecko_sdk/types/onchain/networks/pools/multi_get_addresses_response.py index dbecbf8..77addd5 100644 --- a/src/coingecko_sdk/types/onchain/networks/pools/multi_get_addresses_response.py +++ b/src/coingecko_sdk/types/onchain/networks/pools/multi_get_addresses_response.py @@ -2,8 +2,8 @@ from typing import List, Optional -from ..pool_data import PoolData from ....._models import BaseModel +from ..pool_address_item import PoolAddressItem __all__ = ["MultiGetAddressesResponse", "Included", "IncludedAttributes"] @@ -31,6 +31,7 @@ class Included(BaseModel): class MultiGetAddressesResponse(BaseModel): - data: Optional[List[PoolData]] = None + data: List[PoolAddressItem] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/pools/ohlcv_get_timeframe_params.py b/src/coingecko_sdk/types/onchain/networks/pools/ohlcv_get_timeframe_params.py index 5578292..7efeeb8 100644 --- a/src/coingecko_sdk/types/onchain/networks/pools/ohlcv_get_timeframe_params.py +++ b/src/coingecko_sdk/types/onchain/networks/pools/ohlcv_get_timeframe_params.py @@ -13,26 +13,27 @@ class OhlcvGetTimeframeParams(TypedDict, total=False): pool_address: Required[str] token: str - """ - return OHLCV for token use this to invert the chart Available values: 'base', - 'quote' or token address Default value: 'base' + """Return OHLCV for token, use this to invert the chart. + + Available values: `base`, `quote`, or token address. Default: `base` """ aggregate: str - """ - time period to aggregate each OHLCV Available values (day): `1` Available values - (hour): `1` , `4` , `12` Available values (minute): `1` , `5` , `15` Available - values (second): `1`, `15`, `30` Default value: 1 + """Time period to aggregate each OHLCV. + + Available values (day): `1` Available values (hour): `1`, `4`, `12` Available + values (minute): `1`, `5`, `15` Available values (second): `1`, `15`, `30` + Default value: 1 """ before_timestamp: int - """return OHLCV data before this timestamp (integer seconds since epoch)""" + """Return OHLCV data before this timestamp (integer seconds since epoch).""" currency: Literal["usd", "token"] - """return OHLCV in USD or quote token Default value: usd""" + """Return OHLCV in USD or quote token. Default: `usd`""" include_empty_intervals: bool - """include empty intervals with no trade data, default: false""" + """Include empty intervals with no trade data. Default: `false`""" limit: int - """number of OHLCV results to return, maximum 1000 Default value: 100""" + """Number of OHLCV results to return, maximum 1000. Default value: 100""" diff --git a/src/coingecko_sdk/types/onchain/networks/pools/ohlcv_get_timeframe_response.py b/src/coingecko_sdk/types/onchain/networks/pools/ohlcv_get_timeframe_response.py index 4f6f3a9..a9503e0 100644 --- a/src/coingecko_sdk/types/onchain/networks/pools/ohlcv_get_timeframe_response.py +++ b/src/coingecko_sdk/types/onchain/networks/pools/ohlcv_get_timeframe_response.py @@ -8,18 +8,23 @@ class DataAttributes(BaseModel): - ohlcv_list: Optional[List[List[float]]] = None + ohlcv_list: List[List[float]] + """OHLCV data as [timestamp, open, high, low, close, volume] arrays""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Request ID""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class MetaBase(BaseModel): + """Base token metadata""" + address: Optional[str] = None coingecko_coin_id: Optional[str] = None @@ -30,6 +35,8 @@ class MetaBase(BaseModel): class MetaQuote(BaseModel): + """Quote token metadata""" + address: Optional[str] = None coingecko_coin_id: Optional[str] = None @@ -41,11 +48,13 @@ class MetaQuote(BaseModel): class Meta(BaseModel): base: Optional[MetaBase] = None + """Base token metadata""" quote: Optional[MetaQuote] = None + """Quote token metadata""" class OhlcvGetTimeframeResponse(BaseModel): - data: Optional[Data] = None + data: Data - meta: Optional[Meta] = None + meta: Meta diff --git a/src/coingecko_sdk/types/onchain/networks/pools/trade_get_params.py b/src/coingecko_sdk/types/onchain/networks/pools/trade_get_params.py index 1c8fdf8..1aa8ca2 100644 --- a/src/coingecko_sdk/types/onchain/networks/pools/trade_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/pools/trade_get_params.py @@ -11,10 +11,10 @@ class TradeGetParams(TypedDict, total=False): network: Required[str] token: str - """ - return trades for token use this to invert the chart Available values: 'base', - 'quote' or token address Default value: 'base' + """Return trades for token, use this to invert the chart. + + Available values: `base`, `quote`, or token address. Default: `base` """ trade_volume_in_usd_greater_than: float - """filter trades by trade volume in USD greater than this value Default value: 0""" + """Filter trades by trade volume in USD greater than this value. Default value: 0""" diff --git a/src/coingecko_sdk/types/onchain/networks/pools/trade_get_response.py b/src/coingecko_sdk/types/onchain/networks/pools/trade_get_response.py index 4d840e6..6d5a0f4 100644 --- a/src/coingecko_sdk/types/onchain/networks/pools/trade_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/pools/trade_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ....._models import BaseModel @@ -8,42 +8,58 @@ class DataAttributes(BaseModel): - block_number: Optional[int] = None + block_number: int + """Block number of the trade""" - block_timestamp: Optional[str] = None + block_timestamp: str + """Block timestamp""" - from_token_address: Optional[str] = None + from_token_address: str + """From-token contract address""" - from_token_amount: Optional[str] = None + from_token_amount: str + """Amount of token sent""" - kind: Optional[str] = None + kind: str + """Trade kind (buy or sell)""" - price_from_in_currency_token: Optional[str] = None + price_from_in_currency_token: str + """Price of from-token in currency token""" - price_from_in_usd: Optional[str] = None + price_from_in_usd: str + """Price of from-token in USD""" - price_to_in_currency_token: Optional[str] = None + price_to_in_currency_token: str + """Price of to-token in currency token""" - price_to_in_usd: Optional[str] = None + price_to_in_usd: str + """Price of to-token in USD""" - to_token_address: Optional[str] = None + to_token_address: str + """To-token contract address""" - to_token_amount: Optional[str] = None + to_token_amount: str + """Amount of token received""" - tx_from_address: Optional[str] = None + tx_from_address: str + """Transaction sender address""" - tx_hash: Optional[str] = None + tx_hash: str + """Transaction hash""" - volume_in_usd: Optional[str] = None + volume_in_usd: str + """Trade volume in USD""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Trade identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class TradeGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] diff --git a/src/coingecko_sdk/types/onchain/networks/token_get_address_params.py b/src/coingecko_sdk/types/onchain/networks/token_get_address_params.py index 73f91bc..4afc632 100644 --- a/src/coingecko_sdk/types/onchain/networks/token_get_address_params.py +++ b/src/coingecko_sdk/types/onchain/networks/token_get_address_params.py @@ -11,13 +11,13 @@ class TokenGetAddressParams(TypedDict, total=False): network: Required[str] include: Literal["top_pools"] - """attributes to include""" + """Attributes to include.""" include_composition: bool - """include pool composition, default: false""" + """Include pool composition. Default: `false`""" include_inactive_source: bool - """ - include token data from inactive pools using the most recent swap, default: - false + """Include token data from inactive pools using the most recent swap. + + Default: `false` """ diff --git a/src/coingecko_sdk/types/onchain/networks/token_get_address_response.py b/src/coingecko_sdk/types/onchain/networks/token_get_address_response.py index c05f46b..44f6ebe 100644 --- a/src/coingecko_sdk/types/onchain/networks/token_get_address_response.py +++ b/src/coingecko_sdk/types/onchain/networks/token_get_address_response.py @@ -3,15 +3,10 @@ from typing import List, Optional from ...._models import BaseModel +from .token_item import TokenItem __all__ = [ "TokenGetAddressResponse", - "Data", - "DataAttributes", - "DataAttributesVolumeUsd", - "DataRelationships", - "DataRelationshipsTopPools", - "DataRelationshipsTopPoolsData", "Included", "IncludedAttributes", "IncludedAttributesPriceChangePercentage", @@ -33,64 +28,6 @@ ] -class DataAttributesVolumeUsd(BaseModel): - h24: Optional[str] = None - - -class DataAttributes(BaseModel): - address: Optional[str] = None - - coingecko_coin_id: Optional[str] = None - - decimals: Optional[int] = None - - fdv_usd: Optional[str] = None - - image_url: Optional[str] = None - - last_trade_timestamp: Optional[int] = None - - market_cap_usd: Optional[str] = None - - name: Optional[str] = None - - normalized_total_supply: Optional[str] = None - - price_usd: Optional[str] = None - - symbol: Optional[str] = None - - total_reserve_in_usd: Optional[str] = None - - total_supply: Optional[str] = None - - volume_usd: Optional[DataAttributesVolumeUsd] = None - - -class DataRelationshipsTopPoolsData(BaseModel): - id: Optional[str] = None - - type: Optional[str] = None - - -class DataRelationshipsTopPools(BaseModel): - data: Optional[List[DataRelationshipsTopPoolsData]] = None - - -class DataRelationships(BaseModel): - top_pools: Optional[DataRelationshipsTopPools] = None - - -class Data(BaseModel): - id: Optional[str] = None - - attributes: Optional[DataAttributes] = None - - relationships: Optional[DataRelationships] = None - - type: Optional[str] = None - - class IncludedAttributesPriceChangePercentage(BaseModel): h1: Optional[str] = None @@ -196,10 +133,6 @@ class IncludedAttributesVolumeUsd(BaseModel): class IncludedAttributes(BaseModel): address: Optional[str] = None - base_token_balance: Optional[str] = None - - base_token_liquidity_usd: Optional[str] = None - base_token_price_native_currency: Optional[str] = None base_token_price_quote_token: Optional[str] = None @@ -208,6 +141,8 @@ class IncludedAttributes(BaseModel): fdv_usd: Optional[str] = None + last_trade_timestamp: Optional[str] = None + market_cap_usd: Optional[str] = None name: Optional[str] = None @@ -216,10 +151,6 @@ class IncludedAttributes(BaseModel): price_change_percentage: Optional[IncludedAttributesPriceChangePercentage] = None - quote_token_balance: Optional[str] = None - - quote_token_liquidity_usd: Optional[str] = None - quote_token_price_base_token: Optional[str] = None quote_token_price_native_currency: Optional[str] = None @@ -284,6 +215,7 @@ class Included(BaseModel): class TokenGetAddressResponse(BaseModel): - data: Optional[Data] = None + data: TokenItem included: Optional[List[Included]] = None + """Included top pool data, present when include=top_pools is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/token_item.py b/src/coingecko_sdk/types/onchain/networks/token_item.py new file mode 100644 index 0000000..a70be63 --- /dev/null +++ b/src/coingecko_sdk/types/onchain/networks/token_item.py @@ -0,0 +1,106 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional + +from ...._models import BaseModel + +__all__ = [ + "TokenItem", + "Attributes", + "AttributesVolumeUsd", + "AttributesLaunchpadDetails", + "Relationships", + "RelationshipsTopPools", + "RelationshipsTopPoolsData", +] + + +class AttributesVolumeUsd(BaseModel): + """Volume in USD""" + + h24: Optional[str] = None + + +class AttributesLaunchpadDetails(BaseModel): + """Launchpad details for pump-style tokens""" + + completed: Optional[bool] = None + + completed_at: Optional[str] = None + + graduation_percentage: Optional[float] = None + + migrated_destination_pool_address: Optional[str] = None + + +class Attributes(BaseModel): + address: str + """Token contract address""" + + coingecko_coin_id: Optional[str] = None + """CoinGecko coin ID""" + + decimals: int + """Token decimals""" + + fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" + + image_url: Optional[str] = None + """Token image URL""" + + market_cap_usd: Optional[str] = None + """Market cap in USD""" + + name: str + """Token name""" + + normalized_total_supply: str + """Normalized token total supply""" + + price_usd: Optional[str] = None + """Token price in USD""" + + symbol: str + """Token symbol""" + + total_reserve_in_usd: str + """Total reserve in USD across all pools""" + + total_supply: str + """Token total supply""" + + volume_usd: AttributesVolumeUsd + """Volume in USD""" + + last_trade_timestamp: Optional[str] = None + """Last trade timestamp in UNIX""" + + launchpad_details: Optional[AttributesLaunchpadDetails] = None + """Launchpad details for pump-style tokens""" + + +class RelationshipsTopPoolsData(BaseModel): + id: Optional[str] = None + + type: Optional[str] = None + + +class RelationshipsTopPools(BaseModel): + data: Optional[List[RelationshipsTopPoolsData]] = None + + +class Relationships(BaseModel): + top_pools: Optional[RelationshipsTopPools] = None + + +class TokenItem(BaseModel): + id: str + """Token identifier""" + + attributes: Attributes + + relationships: Relationships + + type: str + """Resource type""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/holders_chart_get_params.py b/src/coingecko_sdk/types/onchain/networks/tokens/holders_chart_get_params.py index 4929314..1f71be3 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/holders_chart_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/holders_chart_get_params.py @@ -11,4 +11,4 @@ class HoldersChartGetParams(TypedDict, total=False): network: Required[str] days: Literal["7", "30", "max"] - """number of days to return the historical token holders chart Default value: 7""" + """Number of days to return the historical token holders chart. Default value: 7""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/holders_chart_get_response.py b/src/coingecko_sdk/types/onchain/networks/tokens/holders_chart_get_response.py index 4b46d55..ca196ae 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/holders_chart_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/holders_chart_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List, Union, Optional from ....._models import BaseModel @@ -8,25 +8,32 @@ class DataAttributes(BaseModel): - token_holders_list: Optional[List[List[str]]] = None + token_holders_list: List[List[Union[str, int]]] + """Historical token holders as [timestamp, holder_count] pairs""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Request ID""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class MetaToken(BaseModel): address: Optional[str] = None + """Token contract address""" coingecko_coin_id: Optional[str] = None + """CoinGecko coin ID""" name: Optional[str] = None + """Token name""" symbol: Optional[str] = None + """Token symbol""" class Meta(BaseModel): @@ -34,6 +41,6 @@ class Meta(BaseModel): class HoldersChartGetResponse(BaseModel): - data: Optional[Data] = None + data: Data - meta: Optional[Meta] = None + meta: Meta diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/info_get_response.py b/src/coingecko_sdk/types/onchain/networks/tokens/info_get_response.py index f0960bc..2858fad 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/info_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/info_get_response.py @@ -1,8 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Union, Optional - -from pydantic import Field as FieldInfo +from typing import Dict, List, Union, Optional from ....._models import BaseModel @@ -12,12 +10,13 @@ "DataAttributes", "DataAttributesGtScoreDetails", "DataAttributesHolders", - "DataAttributesHoldersDistributionPercentage", "DataAttributesImage", ] class DataAttributesGtScoreDetails(BaseModel): + """GeckoTerminal trust score breakdown""" + creation: Optional[float] = None holders: Optional[float] = None @@ -29,25 +28,25 @@ class DataAttributesGtScoreDetails(BaseModel): transaction: Optional[float] = None -class DataAttributesHoldersDistributionPercentage(BaseModel): - dist_11_30: Optional[str] = FieldInfo(alias="11_30", default=None) - - dist_31_50: Optional[str] = FieldInfo(alias="31_50", default=None) - - rest: Optional[str] = None - - top_10: Optional[str] = None - - class DataAttributesHolders(BaseModel): + """Token holder information""" + count: Optional[int] = None + """Number of holders""" - distribution_percentage: Optional[DataAttributesHoldersDistributionPercentage] = None + distribution_percentage: Optional[Dict[str, str]] = None + """Holder distribution percentage (keys vary by chain, e.g. + + top_10, 11_30, 31_50, rest) + """ last_updated: Optional[str] = None + """Last updated timestamp""" class DataAttributesImage(BaseModel): + """Token image URLs in different sizes""" + large: Optional[str] = None small: Optional[str] = None @@ -56,60 +55,85 @@ class DataAttributesImage(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Token contract address""" - categories: Optional[List[str]] = None + categories: List[str] + """Token categories""" coingecko_coin_id: Optional[str] = None + """CoinGecko coin ID""" - decimals: Optional[int] = None + decimals: int + """Token decimals""" description: Optional[str] = None + """Token description""" discord_url: Optional[str] = None + """Discord URL""" farcaster_url: Optional[str] = None + """Farcaster URL""" freeze_authority: Optional[str] = None + """Freeze authority status""" - gt_category_ids: Optional[List[str]] = None + gt_category_ids: List[str] + """GeckoTerminal category IDs""" - gt_score: Optional[float] = None + gt_score: float + """GeckoTerminal trust score""" - gt_score_details: Optional[DataAttributesGtScoreDetails] = None + gt_score_details: DataAttributesGtScoreDetails + """GeckoTerminal trust score breakdown""" - gt_verified: Optional[bool] = None + gt_verified: bool + """Whether the token is verified on GeckoTerminal""" - holders: Optional[DataAttributesHolders] = None + holders: DataAttributesHolders + """Token holder information""" - image: Optional[DataAttributesImage] = None + image: DataAttributesImage + """Token image URLs in different sizes""" image_url: Optional[str] = None + """Token image URL""" - is_honeypot: Union[bool, str, None] = None + is_honeypot: Union[bool, str] + """Whether the token is a honeypot (boolean or 'unknown')""" mint_authority: Optional[str] = None + """Mint authority status""" - name: Optional[str] = None + name: str + """Token name""" - symbol: Optional[str] = None + symbol: str + """Token symbol""" telegram_handle: Optional[str] = None + """Telegram handle""" twitter_handle: Optional[str] = None + """Twitter handle""" - websites: Optional[List[str]] = None + websites: List[str] + """Token websites""" zora_url: Optional[str] = None + """Zora URL""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Token identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class InfoGetResponse(BaseModel): - data: Optional[Data] = None + data: Data diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/multi_get_addresses_params.py b/src/coingecko_sdk/types/onchain/networks/tokens/multi_get_addresses_params.py index efd682f..05e3d29 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/multi_get_addresses_params.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/multi_get_addresses_params.py @@ -11,10 +11,10 @@ class MultiGetAddressesParams(TypedDict, total=False): network: Required[str] include: Literal["top_pools"] - """attributes to include""" + """Attributes to include.""" include_composition: bool - """include pool composition, default: false""" + """Include pool composition. Default: `false`""" include_inactive_source: bool - """include tokens from inactive pools using the most recent swap, default: false""" + """Include tokens from inactive pools using the most recent swap. Default: `false`""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/multi_get_addresses_response.py b/src/coingecko_sdk/types/onchain/networks/tokens/multi_get_addresses_response.py index 38d7db3..12a375a 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/multi_get_addresses_response.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/multi_get_addresses_response.py @@ -3,16 +3,10 @@ from typing import List, Optional from ....._models import BaseModel +from ..token_item import TokenItem __all__ = [ "MultiGetAddressesResponse", - "Data", - "DataAttributes", - "DataAttributesLaunchpadDetails", - "DataAttributesVolumeUsd", - "DataRelationships", - "DataRelationshipsTopPools", - "DataRelationshipsTopPoolsData", "Included", "IncludedAttributes", "IncludedAttributesPriceChangePercentage", @@ -34,76 +28,6 @@ ] -class DataAttributesLaunchpadDetails(BaseModel): - completed: Optional[bool] = None - - completed_at: Optional[str] = None - - graduation_percentage: Optional[float] = None - - migrated_destination_pool_address: Optional[str] = None - - -class DataAttributesVolumeUsd(BaseModel): - h24: Optional[str] = None - - -class DataAttributes(BaseModel): - address: Optional[str] = None - - coingecko_coin_id: Optional[str] = None - - decimals: Optional[int] = None - - fdv_usd: Optional[str] = None - - image_url: Optional[str] = None - - last_trade_timestamp: Optional[int] = None - - launchpad_details: Optional[DataAttributesLaunchpadDetails] = None - - market_cap_usd: Optional[str] = None - - name: Optional[str] = None - - normalized_total_supply: Optional[str] = None - - price_usd: Optional[str] = None - - symbol: Optional[str] = None - - total_reserve_in_usd: Optional[str] = None - - total_supply: Optional[str] = None - - volume_usd: Optional[DataAttributesVolumeUsd] = None - - -class DataRelationshipsTopPoolsData(BaseModel): - id: Optional[str] = None - - type: Optional[str] = None - - -class DataRelationshipsTopPools(BaseModel): - data: Optional[List[DataRelationshipsTopPoolsData]] = None - - -class DataRelationships(BaseModel): - top_pools: Optional[DataRelationshipsTopPools] = None - - -class Data(BaseModel): - id: Optional[str] = None - - attributes: Optional[DataAttributes] = None - - relationships: Optional[DataRelationships] = None - - type: Optional[str] = None - - class IncludedAttributesPriceChangePercentage(BaseModel): h1: Optional[str] = None @@ -209,10 +133,6 @@ class IncludedAttributesVolumeUsd(BaseModel): class IncludedAttributes(BaseModel): address: Optional[str] = None - base_token_balance: Optional[str] = None - - base_token_liquidity_usd: Optional[str] = None - base_token_price_native_currency: Optional[str] = None base_token_price_quote_token: Optional[str] = None @@ -229,10 +149,6 @@ class IncludedAttributes(BaseModel): price_change_percentage: Optional[IncludedAttributesPriceChangePercentage] = None - quote_token_balance: Optional[str] = None - - quote_token_liquidity_usd: Optional[str] = None - quote_token_price_base_token: Optional[str] = None quote_token_price_native_currency: Optional[str] = None @@ -295,6 +211,7 @@ class Included(BaseModel): class MultiGetAddressesResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[TokenItem] included: Optional[List[Included]] = None + """Included top pool data, present when include=top_pools is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/ohlcv_get_timeframe_params.py b/src/coingecko_sdk/types/onchain/networks/tokens/ohlcv_get_timeframe_params.py index cb99ba9..a7de113 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/ohlcv_get_timeframe_params.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/ohlcv_get_timeframe_params.py @@ -13,26 +13,27 @@ class OhlcvGetTimeframeParams(TypedDict, total=False): token_address: Required[str] aggregate: str - """ - time period to aggregate each OHLCV Available values (day): `1` Available values - (hour): `1` , `4` , `12` Available values (minute): `1` , `5` , `15` Available - values (second): `1`, `15`, `30` Default value: 1 + """Time period to aggregate each OHLCV. + + Available values (day): `1` Available values (hour): `1`, `4`, `12` Available + values (minute): `1`, `5`, `15` Available values (second): `1`, `15`, `30` + Default value: 1 """ before_timestamp: int - """return OHLCV data before this timestamp (integer seconds since epoch)""" + """Return OHLCV data before this timestamp (integer seconds since epoch).""" currency: Literal["usd", "token"] - """return OHLCV in USD or quote token Default value: usd""" + """Return OHLCV in USD or quote token. Default: `usd`""" include_empty_intervals: bool - """include empty intervals with no trade data, default: false""" + """Include empty intervals with no trade data. Default: `false`""" include_inactive_source: bool - """ - include token data from inactive pools using the most recent swap, default: - false + """Include token data from inactive pools using the most recent swap. + + Default: `false` """ limit: int - """number of OHLCV results to return, maximum 1000 Default value: 100""" + """Number of OHLCV results to return, maximum 1000. Default value: 100""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/ohlcv_get_timeframe_response.py b/src/coingecko_sdk/types/onchain/networks/tokens/ohlcv_get_timeframe_response.py index 4f6f3a9..a9503e0 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/ohlcv_get_timeframe_response.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/ohlcv_get_timeframe_response.py @@ -8,18 +8,23 @@ class DataAttributes(BaseModel): - ohlcv_list: Optional[List[List[float]]] = None + ohlcv_list: List[List[float]] + """OHLCV data as [timestamp, open, high, low, close, volume] arrays""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Request ID""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class MetaBase(BaseModel): + """Base token metadata""" + address: Optional[str] = None coingecko_coin_id: Optional[str] = None @@ -30,6 +35,8 @@ class MetaBase(BaseModel): class MetaQuote(BaseModel): + """Quote token metadata""" + address: Optional[str] = None coingecko_coin_id: Optional[str] = None @@ -41,11 +48,13 @@ class MetaQuote(BaseModel): class Meta(BaseModel): base: Optional[MetaBase] = None + """Base token metadata""" quote: Optional[MetaQuote] = None + """Quote token metadata""" class OhlcvGetTimeframeResponse(BaseModel): - data: Optional[Data] = None + data: Data - meta: Optional[Meta] = None + meta: Meta diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/pool_get_params.py b/src/coingecko_sdk/types/onchain/networks/tokens/pool_get_params.py index 7120807..eaa7681 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/pool_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/pool_get_params.py @@ -11,22 +11,22 @@ class PoolGetParams(TypedDict, total=False): network: Required[str] include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex` """ include_gt_community_data: bool - """ - include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + """Include GeckoTerminal community data (sentiment votes, suspicious reports). + + Default: `false` """ include_inactive_source: bool - """include tokens from inactive pools using the most recent swap, default: false""" + """Include tokens from inactive pools using the most recent swap. Default: `false`""" page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" sort: Literal["h24_volume_usd_liquidity_desc", "h24_tx_count_desc", "h24_volume_usd_desc"] - """sort the pools by field Default value: h24_volume_usd_liquidity_desc""" + """Sort the pools by field. Default: `h24_volume_usd_liquidity_desc`""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/pool_get_response.py b/src/coingecko_sdk/types/onchain/networks/tokens/pool_get_response.py index c893317..2707096 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/pool_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/pool_get_response.py @@ -22,6 +22,8 @@ "DataRelationshipsBaseTokenData", "DataRelationshipsDex", "DataRelationshipsDexData", + "DataRelationshipsNetwork", + "DataRelationshipsNetworkData", "DataRelationshipsQuoteToken", "DataRelationshipsQuoteTokenData", "Included", @@ -30,6 +32,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -104,6 +108,8 @@ class DataAttributesTransactionsM5(BaseModel): class DataAttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[DataAttributesTransactionsH1] = None h24: Optional[DataAttributesTransactionsH24] = None @@ -118,6 +124,8 @@ class DataAttributesTransactions(BaseModel): class DataAttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -132,45 +140,62 @@ class DataAttributesVolumeUsd(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None - - community_sus_report: Optional[float] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None - - last_trade_timestamp: Optional[int] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" + + transactions: DataAttributesTransactions + """Transaction counts over various timeframes""" + + volume_usd: DataAttributesVolumeUsd + """Volume in USD over various timeframes""" + + community_sus_report: Optional[int] = None + """GeckoTerminal community suspicious reports count""" sentiment_vote_negative_percentage: Optional[float] = None + """GeckoTerminal community negative sentiment vote percentage""" sentiment_vote_positive_percentage: Optional[float] = None + """GeckoTerminal community positive sentiment vote percentage""" token_price_usd: Optional[str] = None - - transactions: Optional[DataAttributesTransactions] = None - - volume_usd: Optional[DataAttributesVolumeUsd] = None + """Price of the queried token in USD, present when querying pools by token address""" class DataRelationshipsBaseTokenData(BaseModel): @@ -193,6 +218,16 @@ class DataRelationshipsDex(BaseModel): data: Optional[DataRelationshipsDexData] = None +class DataRelationshipsNetworkData(BaseModel): + id: Optional[str] = None + + type: Optional[str] = None + + +class DataRelationshipsNetwork(BaseModel): + data: Optional[DataRelationshipsNetworkData] = None + + class DataRelationshipsQuoteTokenData(BaseModel): id: Optional[str] = None @@ -204,26 +239,35 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None + network: Optional[DataRelationshipsNetwork] = None + quote_token: Optional[DataRelationshipsQuoteToken] = None class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -244,6 +288,7 @@ class Included(BaseModel): class PoolGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/top_holder_get_params.py b/src/coingecko_sdk/types/onchain/networks/tokens/top_holder_get_params.py index aa976a8..704894e 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/top_holder_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/top_holder_get_params.py @@ -11,10 +11,7 @@ class TopHolderGetParams(TypedDict, total=False): network: Required[str] holders: str - """ - number of top token holders to return, you may use any integer or `max` Default - value: 10 - """ + """Number of top token holders to return, any integer or `max`. Default value: 10""" include_pnl_details: bool - """include PnL details for token holders, default: false""" + """Include PnL details for token holders. Default: `false`""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/top_holder_get_response.py b/src/coingecko_sdk/types/onchain/networks/tokens/top_holder_get_response.py index 67e709f..77fed2f 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/top_holder_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/top_holder_get_response.py @@ -8,48 +8,65 @@ class DataAttributesHolder(BaseModel): - address: Optional[str] = None + address: str + """Holder wallet address""" - amount: Optional[str] = None + amount: str + """Token amount held""" - average_buy_price_usd: Optional[str] = None + label: Optional[str] = None + """Address label""" - explorer_url: Optional[str] = None + percentage: str + """Percentage of total supply held""" - label: Optional[str] = None + rank: int + """Holder rank""" - percentage: Optional[str] = None + value: str + """Value of holdings in USD""" - rank: Optional[float] = None + average_buy_price_usd: Optional[str] = None + """Average buy price in USD""" + + explorer_url: Optional[str] = None + """Block explorer URL for the holder address""" realized_pnl_percentage: Optional[str] = None + """Realized PnL percentage""" realized_pnl_usd: Optional[str] = None + """Realized PnL in USD""" - total_buy_count: Optional[float] = None + total_buy_count: Optional[int] = None + """Total number of buy transactions""" - total_sell_count: Optional[float] = None + total_sell_count: Optional[int] = None + """Total number of sell transactions""" unrealized_pnl_percentage: Optional[str] = None + """Unrealized PnL percentage""" unrealized_pnl_usd: Optional[str] = None - - value: Optional[str] = None + """Unrealized PnL in USD""" class DataAttributes(BaseModel): - holders: Optional[List[DataAttributesHolder]] = None + holders: List[DataAttributesHolder] - last_updated_at: Optional[str] = None + last_updated_at: str + """Data last updated timestamp""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Token identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class TopHolderGetResponse(BaseModel): - data: Optional[Data] = None + data: Data diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/top_trader_get_params.py b/src/coingecko_sdk/types/onchain/networks/tokens/top_trader_get_params.py index 837013f..c132655 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/top_trader_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/top_trader_get_params.py @@ -11,13 +11,10 @@ class TopTraderGetParams(TypedDict, total=False): network_id: Required[str] include_address_label: bool - """include address label data, default: false""" + """Include address label data. Default: `false`""" sort: Literal["realized_pnl_usd_desc", "unrealized_pnl_usd_desc", "total_buy_usd_desc", "total_sell_usd_desc"] - """sort the traders by field Default value: realized_pnl_usd_desc""" + """Sort the traders by field. Default: `realized_pnl_usd_desc`""" traders: str - """ - number of top token traders to return, you may use any integer or `max` Default - value: 10 - """ + """Number of top token traders to return, any integer or `max`. Default value: 10""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/top_trader_get_response.py b/src/coingecko_sdk/types/onchain/networks/tokens/top_trader_get_response.py index 71461a1..52534fc 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/top_trader_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/top_trader_get_response.py @@ -8,50 +8,68 @@ class DataAttributesTrader(BaseModel): - address: Optional[str] = None + address: str + """Trader wallet address""" - average_buy_price_usd: Optional[str] = None + average_buy_price_usd: str + """Average buy price in USD""" - average_sell_price_usd: Optional[str] = None + average_sell_price_usd: str + """Average sell price in USD""" - explorer_url: Optional[str] = None + explorer_url: str + """Block explorer URL for the trader address""" - label: Optional[str] = None + realized_pnl_usd: str + """Realized PnL in USD""" - name: Optional[str] = None + token_balance: Optional[str] = None + """Current token balance""" - realized_pnl_usd: Optional[str] = None + total_buy_count: int + """Total number of buy transactions""" - token_balance: Optional[str] = None + total_buy_token_amount: str + """Total buy token amount""" - total_buy_count: Optional[int] = None + total_buy_usd: str + """Total buy amount in USD""" - total_buy_token_amount: Optional[str] = None + total_sell_count: int + """Total number of sell transactions""" - total_buy_usd: Optional[str] = None + total_sell_token_amount: str + """Total sell token amount""" - total_sell_count: Optional[int] = None + total_sell_usd: str + """Total sell amount in USD""" - total_sell_token_amount: Optional[str] = None + unrealized_pnl_usd: Optional[str] = None + """Unrealized PnL in USD""" - total_sell_usd: Optional[str] = None + label: Optional[str] = None + """Address label""" - type: Optional[str] = None + name: Optional[str] = None + """Address label name""" - unrealized_pnl_usd: Optional[str] = None + type: Optional[str] = None + """Address type""" class DataAttributes(BaseModel): - traders: Optional[List[DataAttributesTrader]] = None + traders: List[DataAttributesTrader] class Data(BaseModel): - id: Optional[str] = None + id: str + """Token identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class TopTraderGetResponse(BaseModel): - data: Optional[Data] = None + data: Data diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/trade_get_params.py b/src/coingecko_sdk/types/onchain/networks/tokens/trade_get_params.py index 0fc9336..17c61a9 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/trade_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/trade_get_params.py @@ -11,4 +11,4 @@ class TradeGetParams(TypedDict, total=False): network: Required[str] trade_volume_in_usd_greater_than: float - """filter trades by trade volume in USD greater than this value Default value: 0""" + """Filter trades by trade volume in USD greater than this value. Default value: 0""" diff --git a/src/coingecko_sdk/types/onchain/networks/tokens/trade_get_response.py b/src/coingecko_sdk/types/onchain/networks/tokens/trade_get_response.py index e1fd1bd..6a2dc81 100644 --- a/src/coingecko_sdk/types/onchain/networks/tokens/trade_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/tokens/trade_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from ....._models import BaseModel @@ -8,46 +8,64 @@ class DataAttributes(BaseModel): - block_number: Optional[int] = None + block_number: int + """Block number of the trade""" - block_timestamp: Optional[str] = None + block_timestamp: str + """Block timestamp""" - from_token_address: Optional[str] = None + from_token_address: str + """From-token contract address""" - from_token_amount: Optional[str] = None + from_token_amount: str + """Amount of token sent""" - kind: Optional[str] = None + kind: str + """Trade kind (buy or sell)""" - pool_address: Optional[str] = None + pool_address: str + """Pool contract address where the trade occurred""" - pool_dex: Optional[str] = None + pool_dex: str + """DEX identifier of the pool""" - price_from_in_currency_token: Optional[str] = None + price_from_in_currency_token: str + """Price of from-token in currency token""" - price_from_in_usd: Optional[str] = None + price_from_in_usd: str + """Price of from-token in USD""" - price_to_in_currency_token: Optional[str] = None + price_to_in_currency_token: str + """Price of to-token in currency token""" - price_to_in_usd: Optional[str] = None + price_to_in_usd: str + """Price of to-token in USD""" - to_token_address: Optional[str] = None + to_token_address: str + """To-token contract address""" - to_token_amount: Optional[str] = None + to_token_amount: str + """Amount of token received""" - tx_from_address: Optional[str] = None + tx_from_address: str + """Transaction sender address""" - tx_hash: Optional[str] = None + tx_hash: str + """Transaction hash""" - volume_in_usd: Optional[str] = None + volume_in_usd: str + """Trade volume in USD""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Trade identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Resource type""" class TradeGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] diff --git a/src/coingecko_sdk/types/onchain/networks/trending_pool_get_network_params.py b/src/coingecko_sdk/types/onchain/networks/trending_pool_get_network_params.py index f052b31..8701093 100644 --- a/src/coingecko_sdk/types/onchain/networks/trending_pool_get_network_params.py +++ b/src/coingecko_sdk/types/onchain/networks/trending_pool_get_network_params.py @@ -9,19 +9,19 @@ class TrendingPoolGetNetworkParams(TypedDict, total=False): duration: Literal["5m", "1h", "6h", "24h"] - """duration to sort trending list by Default value: 24h""" + """Duration to sort trending list by. Default: `24h`""" include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex` """ include_gt_community_data: bool - """ - include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + """Include GeckoTerminal community data (sentiment votes, suspicious reports). + + Default: `false` """ page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" diff --git a/src/coingecko_sdk/types/onchain/networks/trending_pool_get_network_response.py b/src/coingecko_sdk/types/onchain/networks/trending_pool_get_network_response.py index 104f78a..c8b1367 100644 --- a/src/coingecko_sdk/types/onchain/networks/trending_pool_get_network_response.py +++ b/src/coingecko_sdk/types/onchain/networks/trending_pool_get_network_response.py @@ -32,6 +32,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -106,6 +108,8 @@ class DataAttributesTransactionsM5(BaseModel): class DataAttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[DataAttributesTransactionsH1] = None h24: Optional[DataAttributesTransactionsH24] = None @@ -120,6 +124,8 @@ class DataAttributesTransactions(BaseModel): class DataAttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -134,41 +140,62 @@ class DataAttributesVolumeUsd(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None - - community_sus_report: Optional[float] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" + + transactions: DataAttributesTransactions + """Transaction counts over various timeframes""" + + volume_usd: DataAttributesVolumeUsd + """Volume in USD over various timeframes""" + + community_sus_report: Optional[int] = None + """GeckoTerminal community suspicious reports count""" sentiment_vote_negative_percentage: Optional[float] = None + """GeckoTerminal community negative sentiment vote percentage""" sentiment_vote_positive_percentage: Optional[float] = None + """GeckoTerminal community positive sentiment vote percentage""" - transactions: Optional[DataAttributesTransactions] = None - - volume_usd: Optional[DataAttributesVolumeUsd] = None + token_price_usd: Optional[str] = None + """Price of the queried token in USD, present when querying pools by token address""" class DataRelationshipsBaseTokenData(BaseModel): @@ -212,6 +239,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -222,18 +251,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -254,6 +288,7 @@ class Included(BaseModel): class TrendingPoolGetNetworkResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/networks/trending_pool_get_params.py b/src/coingecko_sdk/types/onchain/networks/trending_pool_get_params.py index 5c32e0a..146be69 100644 --- a/src/coingecko_sdk/types/onchain/networks/trending_pool_get_params.py +++ b/src/coingecko_sdk/types/onchain/networks/trending_pool_get_params.py @@ -9,20 +9,19 @@ class TrendingPoolGetParams(TypedDict, total=False): duration: Literal["5m", "1h", "6h", "24h"] - """duration to sort trending list by Default value: 24h""" + """Duration to sort trending list by. Default: `24h`""" include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network`. Example: `base_token` or - `base_token,dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex`, `network` """ include_gt_community_data: bool - """ - include GeckoTerminal community data (Sentiment votes, Suspicious reports) - Default value: false + """Include GeckoTerminal community data (sentiment votes, suspicious reports). + + Default: `false` """ page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" diff --git a/src/coingecko_sdk/types/onchain/networks/trending_pool_get_response.py b/src/coingecko_sdk/types/onchain/networks/trending_pool_get_response.py index 0c9a356..b7ec874 100644 --- a/src/coingecko_sdk/types/onchain/networks/trending_pool_get_response.py +++ b/src/coingecko_sdk/types/onchain/networks/trending_pool_get_response.py @@ -32,6 +32,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -106,6 +108,8 @@ class DataAttributesTransactionsM5(BaseModel): class DataAttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[DataAttributesTransactionsH1] = None h24: Optional[DataAttributesTransactionsH24] = None @@ -120,6 +124,8 @@ class DataAttributesTransactions(BaseModel): class DataAttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -134,41 +140,62 @@ class DataAttributesVolumeUsd(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None - - community_sus_report: Optional[float] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" + + transactions: DataAttributesTransactions + """Transaction counts over various timeframes""" + + volume_usd: DataAttributesVolumeUsd + """Volume in USD over various timeframes""" + + community_sus_report: Optional[int] = None + """GeckoTerminal community suspicious reports count""" sentiment_vote_negative_percentage: Optional[float] = None + """GeckoTerminal community negative sentiment vote percentage""" sentiment_vote_positive_percentage: Optional[float] = None + """GeckoTerminal community positive sentiment vote percentage""" - transactions: Optional[DataAttributesTransactions] = None - - volume_usd: Optional[DataAttributesVolumeUsd] = None + token_price_usd: Optional[str] = None + """Price of the queried token in USD, present when querying pools by token address""" class DataRelationshipsBaseTokenData(BaseModel): @@ -212,6 +239,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -222,18 +251,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -254,6 +288,7 @@ class Included(BaseModel): class TrendingPoolGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/pools/megafilter_get_params.py b/src/coingecko_sdk/types/onchain/pools/megafilter_get_params.py index e42c03e..6e7595d 100644 --- a/src/coingecko_sdk/types/onchain/pools/megafilter_get_params.py +++ b/src/coingecko_sdk/types/onchain/pools/megafilter_get_params.py @@ -9,100 +9,100 @@ class MegafilterGetParams(TypedDict, total=False): buy_tax_percentage_max: float - """maximum buy tax percentage""" + """Maximum buy tax percentage.""" buy_tax_percentage_min: float - """minimum buy tax percentage""" + """Minimum buy tax percentage.""" buys_duration: Literal["5m", "1h", "6h", "24h"] - """duration for buy transactions metric Default value: 24h""" + """Duration for buy transactions metric. Default: `24h`""" buys_max: int - """maximum number of buy transactions""" + """Maximum number of buy transactions.""" buys_min: int - """minimum number of buy transactions""" + """Minimum number of buy transactions.""" checks: str - """ - filter options for various checks, comma-separated if more than one Available - values: `no_honeypot`, `good_gt_score`, `on_coingecko`, `has_social` + """Filter options for various checks, comma-separated if more than one. + + Available values: `no_honeypot`, `good_gt_score`, `on_coingecko`, `has_social` """ dexes: str - """ - filter pools by DEXes, comma-separated if more than one DEX ID refers to - [/networks/{network}/dexes](/reference/dexes-list) + """Filter pools by DEXes, comma-separated if more than one. + + \\**refers to [`/onchain/networks/{network}/dexes`](/reference/dexes-list). """ fdv_usd_max: float - """maximum fully diluted value in USD""" + """Maximum fully diluted value in USD.""" fdv_usd_min: float - """minimum fully diluted value in USD""" + """Minimum fully diluted value in USD.""" h24_volume_usd_max: float - """maximum 24hr volume in USD""" + """Maximum 24hr volume in USD.""" h24_volume_usd_min: float - """minimum 24hr volume in USD""" + """Minimum 24hr volume in USD.""" include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex`, `network` """ include_unknown_honeypot_tokens: bool """ - when `checks` includes `no_honeypot`, set to **`true`** to also include 'unknown - honeypot' tokens. Default value: `false` + When `checks` includes `no_honeypot`, set to `true` to also include unknown + honeypot tokens. Default: `false` """ networks: str - """ - filter pools by networks, comma-separated if more than one Network ID refers to - [/networks](/reference/networks-list) + """Filter pools by networks, comma-separated if more than one. + + \\**refers to [`/onchain/networks`](/reference/networks-list). """ page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" pool_created_hour_max: float - """maximum pool age in hours""" + """Maximum pool age in hours.""" pool_created_hour_min: float - """minimum pool age in hours""" + """Minimum pool age in hours.""" price_change_percentage_duration: Literal["5m", "1h", "6h", "24h"] - """duration for price change percentage metric""" + """Duration for price change percentage metric. Default: `24h`""" price_change_percentage_max: float - """maximum price change percentage""" + """Maximum price change percentage.""" price_change_percentage_min: float - """minimum price change percentage""" + """Minimum price change percentage.""" reserve_in_usd_max: float - """maximum reserve in USD""" + """Maximum reserve in USD.""" reserve_in_usd_min: float - """minimum reserve in USD""" + """Minimum reserve in USD.""" sell_tax_percentage_max: float - """maximum sell tax percentage""" + """Maximum sell tax percentage.""" sell_tax_percentage_min: float - """minimum sell tax percentage""" + """Minimum sell tax percentage.""" sells_duration: Literal["5m", "1h", "6h", "24h"] - """duration for sell transactions metric Default value: 24h""" + """Duration for sell transactions metric. Default: `24h`""" sells_max: int - """maximum number of sell transactions""" + """Maximum number of sell transactions.""" sells_min: int - """minimum number of sell transactions""" + """Minimum number of sell transactions.""" sort: Literal[ "m5_trending", @@ -129,13 +129,13 @@ class MegafilterGetParams(TypedDict, total=False): "price_desc", "pool_created_at_desc", ] - """sort the pools by field Default value: h6_trending""" + """Sort the pools by field. Default: `h6_trending`""" tx_count_duration: Literal["5m", "1h", "6h", "24h"] - """duration for transaction count metric Default value: 24h""" + """Duration for transaction count metric. Default: `24h`""" tx_count_max: int - """maximum transaction count""" + """Maximum transaction count.""" tx_count_min: int - """minimum transaction count""" + """Minimum transaction count.""" diff --git a/src/coingecko_sdk/types/onchain/pools/megafilter_get_response.py b/src/coingecko_sdk/types/onchain/pools/megafilter_get_response.py index 496f03a..4231436 100644 --- a/src/coingecko_sdk/types/onchain/pools/megafilter_get_response.py +++ b/src/coingecko_sdk/types/onchain/pools/megafilter_get_response.py @@ -32,6 +32,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -106,6 +108,8 @@ class DataAttributesTransactionsM5(BaseModel): class DataAttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[DataAttributesTransactionsH1] = None h24: Optional[DataAttributesTransactionsH24] = None @@ -120,6 +124,8 @@ class DataAttributesTransactions(BaseModel): class DataAttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -134,35 +140,62 @@ class DataAttributesVolumeUsd(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" + + transactions: DataAttributesTransactions + """Transaction counts over various timeframes""" + + volume_usd: DataAttributesVolumeUsd + """Volume in USD over various timeframes""" - transactions: Optional[DataAttributesTransactions] = None + community_sus_report: Optional[int] = None + """GeckoTerminal community suspicious reports count""" - volume_usd: Optional[DataAttributesVolumeUsd] = None + sentiment_vote_negative_percentage: Optional[float] = None + """GeckoTerminal community negative sentiment vote percentage""" + + sentiment_vote_positive_percentage: Optional[float] = None + """GeckoTerminal community positive sentiment vote percentage""" + + token_price_usd: Optional[str] = None + """Price of the queried token in USD, present when querying pools by token address""" class DataRelationshipsBaseTokenData(BaseModel): @@ -206,6 +239,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -216,18 +251,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -248,6 +288,7 @@ class Included(BaseModel): class MegafilterGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/pools/trending_search_get_params.py b/src/coingecko_sdk/types/onchain/pools/trending_search_get_params.py index 5153447..656b511 100644 --- a/src/coingecko_sdk/types/onchain/pools/trending_search_get_params.py +++ b/src/coingecko_sdk/types/onchain/pools/trending_search_get_params.py @@ -9,10 +9,10 @@ class TrendingSearchGetParams(TypedDict, total=False): include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex`, `network` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex`, `network` """ pools: int - """number of pools to return, maximum 10 Default value: 4""" + """Number of pools to return, maximum 10. Default value: 4""" diff --git a/src/coingecko_sdk/types/onchain/pools/trending_search_get_response.py b/src/coingecko_sdk/types/onchain/pools/trending_search_get_response.py index 5d8e940..9d83940 100644 --- a/src/coingecko_sdk/types/onchain/pools/trending_search_get_response.py +++ b/src/coingecko_sdk/types/onchain/pools/trending_search_get_response.py @@ -24,25 +24,35 @@ class DataAttributesVolumeUsd(BaseModel): + """Volume in USD""" + h24: Optional[str] = None class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" - trending_rank: Optional[int] = None + trending_rank: int + """Trending search rank (0-based)""" - volume_usd: Optional[DataAttributesVolumeUsd] = None + volume_usd: DataAttributesVolumeUsd + """Volume in USD""" class DataRelationshipsBaseTokenData(BaseModel): @@ -86,6 +96,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -96,18 +108,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -128,6 +145,7 @@ class Included(BaseModel): class TrendingSearchGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/search/pool_get_params.py b/src/coingecko_sdk/types/onchain/search/pool_get_params.py index 9484fb0..65b31d7 100644 --- a/src/coingecko_sdk/types/onchain/search/pool_get_params.py +++ b/src/coingecko_sdk/types/onchain/search/pool_get_params.py @@ -9,19 +9,19 @@ class PoolGetParams(TypedDict, total=False): include: str - """ - attributes to include, comma-separated if more than one to include Available - values: `base_token`, `quote_token`, `dex` + """Attributes to include, comma-separated if more than one. + + Available values: `base_token`, `quote_token`, `dex` """ network: str - """network ID \\**refers to [/networks](/reference/networks-list)""" + """Network ID. \\**refers to [`/onchain/networks`](/reference/networks-list).""" page: int - """page through results Default value: 1""" + """Page through results. Default value: 1""" query: str """ - search query, can be pool contract address, token name, token symbol, or token - contract address + Search query: pool contract address, token name, token symbol, or token contract + address. """ diff --git a/src/coingecko_sdk/types/onchain/search/pool_get_response.py b/src/coingecko_sdk/types/onchain/search/pool_get_response.py index 909a93c..0af3db1 100644 --- a/src/coingecko_sdk/types/onchain/search/pool_get_response.py +++ b/src/coingecko_sdk/types/onchain/search/pool_get_response.py @@ -32,6 +32,8 @@ class DataAttributesPriceChangePercentage(BaseModel): + """Price change percentage over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -106,6 +108,8 @@ class DataAttributesTransactionsM5(BaseModel): class DataAttributesTransactions(BaseModel): + """Transaction counts over various timeframes""" + h1: Optional[DataAttributesTransactionsH1] = None h24: Optional[DataAttributesTransactionsH24] = None @@ -120,6 +124,8 @@ class DataAttributesTransactions(BaseModel): class DataAttributesVolumeUsd(BaseModel): + """Volume in USD over various timeframes""" + h1: Optional[str] = None h24: Optional[str] = None @@ -134,35 +140,50 @@ class DataAttributesVolumeUsd(BaseModel): class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Pool contract address""" base_token_price_native_currency: Optional[str] = None + """Base token price in native currency""" base_token_price_quote_token: Optional[str] = None + """Base token price in quote token""" - base_token_price_usd: Optional[str] = None + base_token_price_usd: str + """Base token price in USD""" fdv_usd: Optional[str] = None + """Fully diluted valuation in USD""" market_cap_usd: Optional[str] = None + """Market cap in USD""" - name: Optional[str] = None + name: str + """Pool name""" - pool_created_at: Optional[str] = None + pool_created_at: str + """Pool creation timestamp""" - price_change_percentage: Optional[DataAttributesPriceChangePercentage] = None + price_change_percentage: DataAttributesPriceChangePercentage + """Price change percentage over various timeframes""" quote_token_price_base_token: Optional[str] = None + """Quote token price in base token""" quote_token_price_native_currency: Optional[str] = None + """Quote token price in native currency""" - quote_token_price_usd: Optional[str] = None + quote_token_price_usd: str + """Quote token price in USD""" reserve_in_usd: Optional[str] = None + """Total reserve in USD""" - transactions: Optional[DataAttributesTransactions] = None + transactions: DataAttributesTransactions + """Transaction counts over various timeframes""" - volume_usd: Optional[DataAttributesVolumeUsd] = None + volume_usd: DataAttributesVolumeUsd + """Volume in USD over various timeframes""" class DataRelationshipsBaseTokenData(BaseModel): @@ -206,6 +227,8 @@ class DataRelationshipsQuoteToken(BaseModel): class DataRelationships(BaseModel): + """Related resources""" + base_token: Optional[DataRelationshipsBaseToken] = None dex: Optional[DataRelationshipsDex] = None @@ -216,18 +239,23 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Pool identifier""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - relationships: Optional[DataRelationships] = None + relationships: DataRelationships + """Related resources""" - type: Optional[str] = None + type: str + """Resource type""" class IncludedAttributes(BaseModel): address: Optional[str] = None + coingecko_asset_platform_id: Optional[str] = None + coingecko_coin_id: Optional[str] = None decimals: Optional[int] = None @@ -248,6 +276,7 @@ class Included(BaseModel): class PoolGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] included: Optional[List[Included]] = None + """Included related resources, present when include parameter is specified""" diff --git a/src/coingecko_sdk/types/onchain/simple/networks/token_price_get_addresses_params.py b/src/coingecko_sdk/types/onchain/simple/networks/token_price_get_addresses_params.py index e205f97..9080c9b 100644 --- a/src/coingecko_sdk/types/onchain/simple/networks/token_price_get_addresses_params.py +++ b/src/coingecko_sdk/types/onchain/simple/networks/token_price_get_addresses_params.py @@ -11,22 +11,22 @@ class TokenPriceGetAddressesParams(TypedDict, total=False): network: Required[str] include_24hr_price_change: bool - """include 24hr price change, default: false""" + """Include 24hr price change. Default: `false`""" include_24hr_vol: bool - """include 24hr volume, default: false""" + """Include 24hr volume. Default: `false`""" include_inactive_source: bool - """ - include token price data from inactive pools using the most recent swap, - default: false + """Include token price data from inactive pools using the most recent swap. + + Default: `false` """ include_market_cap: bool - """include market capitalization, default: false""" + """Include market capitalization. Default: `false`""" include_total_reserve_in_usd: bool - """include total reserve in USD, default: false""" + """Include total reserve in USD. Default: `false`""" mcap_fdv_fallback: bool - """return FDV if market cap is not available, default: false""" + """Return FDV if market cap is not available. Default: `false`""" diff --git a/src/coingecko_sdk/types/onchain/simple/networks/token_price_get_addresses_response.py b/src/coingecko_sdk/types/onchain/simple/networks/token_price_get_addresses_response.py index c1b107d..554e810 100644 --- a/src/coingecko_sdk/types/onchain/simple/networks/token_price_get_addresses_response.py +++ b/src/coingecko_sdk/types/onchain/simple/networks/token_price_get_addresses_response.py @@ -8,26 +8,34 @@ class DataAttributes(BaseModel): + token_prices: Dict[str, str] + """Token prices keyed by contract address""" + h24_price_change_percentage: Optional[Dict[str, str]] = None + """24hr price change percentage keyed by contract address""" h24_volume_usd: Optional[Dict[str, str]] = None + """24hr volume in USD keyed by contract address""" - last_trade_timestamp: Optional[Dict[str, int]] = None + last_trade_timestamp: Optional[Dict[str, str]] = None + """Last trade timestamp keyed by contract address""" market_cap_usd: Optional[Dict[str, str]] = None - - token_prices: Optional[Dict[str, str]] = None + """Market cap in USD keyed by contract address""" total_reserve_in_usd: Optional[Dict[str, str]] = None + """Total reserve in USD keyed by contract address""" class Data(BaseModel): - id: Optional[str] = None + id: str + """Request ID""" - attributes: Optional[DataAttributes] = None + attributes: DataAttributes - type: Optional[str] = None + type: str + """Response type""" class TokenPriceGetAddressesResponse(BaseModel): - data: Optional[Data] = None + data: Data diff --git a/src/coingecko_sdk/types/onchain/tokens/info_recently_updated_get_params.py b/src/coingecko_sdk/types/onchain/tokens/info_recently_updated_get_params.py index e8fba25..7727a7e 100644 --- a/src/coingecko_sdk/types/onchain/tokens/info_recently_updated_get_params.py +++ b/src/coingecko_sdk/types/onchain/tokens/info_recently_updated_get_params.py @@ -9,13 +9,10 @@ class InfoRecentlyUpdatedGetParams(TypedDict, total=False): include: Literal["network"] - """ - Attributes for related resources to include, which will be returned under the - top-level 'included' key - """ + """Attributes for related resources to include.""" network: str - """ - filter tokens by provided network \\**refers to - [/networks](/reference/networks-list) + """Filter tokens by provided network. + + \\**refers to [`/onchain/networks`](/reference/networks-list). """ diff --git a/src/coingecko_sdk/types/onchain/tokens/info_recently_updated_get_response.py b/src/coingecko_sdk/types/onchain/tokens/info_recently_updated_get_response.py index 5bfc66e..b058420 100644 --- a/src/coingecko_sdk/types/onchain/tokens/info_recently_updated_get_response.py +++ b/src/coingecko_sdk/types/onchain/tokens/info_recently_updated_get_response.py @@ -11,39 +11,56 @@ "DataRelationships", "DataRelationshipsNetwork", "DataRelationshipsNetworkData", + "Included", + "IncludedAttributes", ] class DataAttributes(BaseModel): - address: Optional[str] = None + address: str + """Token contract address""" coingecko_coin_id: Optional[str] = None + """CoinGecko coin ID""" - decimals: Optional[int] = None + decimals: int + """Token decimals""" description: Optional[str] = None + """Token description""" discord_url: Optional[str] = None + """Discord URL""" farcaster_url: Optional[str] = None + """Farcaster URL""" gt_score: Optional[float] = None + """GeckoTerminal trust score""" image_url: Optional[str] = None + """Token image URL""" - metadata_updated_at: Optional[str] = None + metadata_updated_at: str + """Metadata last updated timestamp""" - name: Optional[str] = None + name: str + """Token name""" - symbol: Optional[str] = None + symbol: str + """Token symbol""" telegram_handle: Optional[str] = None + """Telegram handle""" twitter_handle: Optional[str] = None + """Twitter handle""" - websites: Optional[List[str]] = None + websites: List[str] + """Token websites""" zora_url: Optional[str] = None + """Zora URL""" class DataRelationshipsNetworkData(BaseModel): @@ -61,14 +78,33 @@ class DataRelationships(BaseModel): class Data(BaseModel): - id: Optional[str] = None + id: str + """Token identifier""" + + attributes: DataAttributes + + relationships: DataRelationships + + type: str + """Resource type""" + - attributes: Optional[DataAttributes] = None +class IncludedAttributes(BaseModel): + coingecko_asset_platform_id: Optional[str] = None - relationships: Optional[DataRelationships] = None + name: Optional[str] = None + + +class Included(BaseModel): + id: Optional[str] = None + + attributes: Optional[IncludedAttributes] = None type: Optional[str] = None class InfoRecentlyUpdatedGetResponse(BaseModel): - data: Optional[List[Data]] = None + data: List[Data] + + included: Optional[List[Included]] = None + """Included network data, present when include=network is specified""" diff --git a/src/coingecko_sdk/types/ping_get_response.py b/src/coingecko_sdk/types/ping_get_response.py index 06d45ba..d48e60a 100644 --- a/src/coingecko_sdk/types/ping_get_response.py +++ b/src/coingecko_sdk/types/ping_get_response.py @@ -1,11 +1,10 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import Optional - from .._models import BaseModel __all__ = ["PingGetResponse"] class PingGetResponse(BaseModel): - gecko_says: Optional[str] = None + gecko_says: str + """API server status message""" diff --git a/src/coingecko_sdk/types/public_treasury_get_coin_id_params.py b/src/coingecko_sdk/types/public_treasury_get_coin_id_params.py index 20420b8..ed2aa68 100644 --- a/src/coingecko_sdk/types/public_treasury_get_coin_id_params.py +++ b/src/coingecko_sdk/types/public_treasury_get_coin_id_params.py @@ -11,10 +11,10 @@ class PublicTreasuryGetCoinIDParams(TypedDict, total=False): entity: Required[Literal["companies", "governments"]] order: Literal["total_holdings_usd_desc", "total_holdings_usd_asc"] - """Sort order for results""" + """Sort order for results. Default: `total_holdings_usd_desc`""" page: int - """Page number to return""" + """Page through results. Default value: 1""" per_page: int - """Number of results to return per page""" + """Total results per page. Default value: 250 Valid values: 1...250""" diff --git a/src/coingecko_sdk/types/public_treasury_get_coin_id_response.py b/src/coingecko_sdk/types/public_treasury_get_coin_id_response.py index 69c1ec9..2b7ef3b 100644 --- a/src/coingecko_sdk/types/public_treasury_get_coin_id_response.py +++ b/src/coingecko_sdk/types/public_treasury_get_coin_id_response.py @@ -4,35 +4,88 @@ from typing_extensions import TypeAlias from .._models import BaseModel -from .treasury_entity import TreasuryEntity -__all__ = ["PublicTreasuryGetCoinIDResponse", "CompaniesTreasury", "GovernmentsTreasury"] +__all__ = [ + "PublicTreasuryGetCoinIDResponse", + "UnionMember0", + "UnionMember0Company", + "UnionMember1", + "UnionMember1Government", +] -class CompaniesTreasury(BaseModel): - companies: Optional[List[TreasuryEntity]] = None +class UnionMember0Company(BaseModel): + country: str + """Country code""" - market_cap_dominance: Optional[float] = None - """market cap dominance""" + name: str + """Company name""" - total_holdings: Optional[float] = None - """total crypto holdings of companies""" + percentage_of_total_supply: float + """Percentage of total crypto supply""" - total_value_usd: Optional[float] = None - """total crypto holdings value in usd""" + symbol: Optional[str] = None + """Company ticker symbol""" + total_current_value_usd: float + """Total current value of crypto holdings in USD""" -class GovernmentsTreasury(BaseModel): - governments: Optional[List[TreasuryEntity]] = None + total_entry_value_usd: float + """Total entry value in USD""" - market_cap_dominance: Optional[float] = None - """market cap dominance""" + total_holdings: float + """Total crypto holdings""" - total_holdings: Optional[float] = None - """total crypto holdings of governments""" - total_value_usd: Optional[float] = None - """total crypto holdings value in usd""" +class UnionMember0(BaseModel): + companies: List[UnionMember0Company] + """List of companies holding crypto""" + market_cap_dominance: float + """Market cap dominance percentage""" -PublicTreasuryGetCoinIDResponse: TypeAlias = Union[CompaniesTreasury, GovernmentsTreasury] + total_holdings: float + """Total crypto holdings""" + + total_value_usd: float + """Total crypto holdings value in USD""" + + +class UnionMember1Government(BaseModel): + country: str + """Country code""" + + name: str + """Government name""" + + percentage_of_total_supply: float + """Percentage of total crypto supply""" + + symbol: Optional[str] = None + """Government ticker symbol""" + + total_current_value_usd: float + """Total current value of crypto holdings in USD""" + + total_entry_value_usd: float + """Total entry value in USD""" + + total_holdings: float + """Total crypto holdings""" + + +class UnionMember1(BaseModel): + governments: List[UnionMember1Government] + """List of governments holding crypto""" + + market_cap_dominance: float + """Market cap dominance percentage""" + + total_holdings: float + """Total crypto holdings""" + + total_value_usd: float + """Total crypto holdings value in USD""" + + +PublicTreasuryGetCoinIDResponse: TypeAlias = Union[UnionMember0, UnionMember1] diff --git a/src/coingecko_sdk/types/public_treasury_get_entity_id_params.py b/src/coingecko_sdk/types/public_treasury_get_entity_id_params.py index 13bcbf9..4d0a14c 100644 --- a/src/coingecko_sdk/types/public_treasury_get_entity_id_params.py +++ b/src/coingecko_sdk/types/public_treasury_get_entity_id_params.py @@ -10,12 +10,14 @@ class PublicTreasuryGetEntityIDParams(TypedDict, total=False): holding_amount_change: str """ - include holding amount change for specified timeframes, comma-separated if - querying more than 1 timeframe Valid values: 7d, 14d, 30d, 90d, 1y, ytd + Include holding amount change for specified timeframes, comma-separated if + querying more than 1 timeframe. Valid values: `7d`, `14d`, `30d`, `90d`, `1y`, + `ytd` """ holding_change_percentage: str """ - include holding change percentage for specified timeframes, comma-separated if - querying more than 1 timeframe Valid values: 7d, 14d, 30d, 90d, 1y, ytd + Include holding change percentage for specified timeframes, comma-separated if + querying more than 1 timeframe. Valid values: `7d`, `14d`, `30d`, `90d`, `1y`, + `ytd` """ diff --git a/src/coingecko_sdk/types/public_treasury_get_entity_id_response.py b/src/coingecko_sdk/types/public_treasury_get_entity_id_response.py index e55fc3f..05aa753 100644 --- a/src/coingecko_sdk/types/public_treasury_get_entity_id_response.py +++ b/src/coingecko_sdk/types/public_treasury_get_entity_id_response.py @@ -15,9 +15,7 @@ class HoldingHoldingAmountChange(BaseModel): - """ - holding amount changes over different timeframes (only present if holding_amount_change param is used) - """ + """Holding amount changes over different timeframes""" period_14d: Optional[float] = FieldInfo(alias="14d", default=None) @@ -33,9 +31,7 @@ class HoldingHoldingAmountChange(BaseModel): class HoldingHoldingChangePercentage(BaseModel): - """ - holding change percentages over different timeframes (only present if holding_change_percentage param is used) - """ + """Holding change percentages over different timeframes""" period_14d: Optional[float] = FieldInfo(alias="14d", default=None) @@ -51,79 +47,73 @@ class HoldingHoldingChangePercentage(BaseModel): class Holding(BaseModel): - amount: Optional[int] = None - """amount of the cryptocurrency held""" + amount: float + """Amount of cryptocurrency held""" - amount_per_share: Optional[float] = None - """amount of cryptocurrency per share""" + amount_per_share: float + """Amount of cryptocurrency per share""" - average_entry_value_usd: Optional[float] = None - """average entry cost per unit in USD""" + average_entry_value_usd: float + """Average entry cost per unit in USD""" - coin_id: Optional[str] = None - """coin ID""" + coin_id: str + """Coin ID""" - current_value_usd: Optional[float] = None - """current value of holdings in USD""" + current_value_usd: float + """Current value of holdings in USD""" - entity_value_usd_percentage: Optional[float] = None - """percentage of entity's total treasury value""" + entity_value_usd_percentage: float + """Percentage of entity's total treasury value""" - holding_amount_change: Optional[HoldingHoldingAmountChange] = None - """ - holding amount changes over different timeframes (only present if - holding_amount_change param is used) - """ + percentage_of_total_supply: float + """Percentage of total crypto supply""" - holding_change_percentage: Optional[HoldingHoldingChangePercentage] = None - """ - holding change percentages over different timeframes (only present if - holding_change_percentage param is used) - """ + total_entry_value_usd: float + """Total entry cost in USD""" - percentage_of_total_supply: Optional[float] = None - """percentage of total crypto supply""" + unrealized_pnl: float + """Unrealized profit and loss for this holding""" - total_entry_value_usd: Optional[float] = None - """total entry cost/purchase value in USD""" + holding_amount_change: Optional[HoldingHoldingAmountChange] = None + """Holding amount changes over different timeframes""" - unrealized_pnl: Optional[float] = None - """unrealized profit and loss for this holding""" + holding_change_percentage: Optional[HoldingHoldingChangePercentage] = None + """Holding change percentages over different timeframes""" class PublicTreasuryGetEntityIDResponse(BaseModel): - id: Optional[str] = None - """entity ID""" + id: str + """Entity ID""" - country: Optional[str] = None - """country code of company or government location""" + country: str + """Country code""" - holdings: Optional[List[Holding]] = None - """list of cryptocurrency assets held by the entity""" + holdings: List[Holding] + """List of cryptocurrency assets held by the entity""" - m_nav: Optional[float] = None - """market to net asset value ratio""" + m_nav: float + """Market to net asset value ratio""" - name: Optional[str] = None - """entity name""" + name: str + """Entity name""" symbol: Optional[str] = None - """stock market symbol for public company""" + """Stock market ticker symbol""" - total_asset_value_per_share_usd: Optional[float] = None - """total asset value per share in USD""" + total_asset_value_per_share_usd: float + """Total asset value per share in USD""" - total_treasury_value_usd: Optional[float] = None - """total current value of all holdings in USD""" + total_treasury_value_usd: float + """Total current value of all holdings in USD""" - twitter_screen_name: Optional[str] = None - """official Twitter handle of the entity""" + twitter_screen_name: str + """Official Twitter handle""" - type: Optional[str] = None - """entity type: company or government""" + type: str + """Entity type: company or government""" - unrealized_pnl: Optional[float] = None - """unrealized profit and loss (current value - total entry value)""" + unrealized_pnl: float + """Unrealized profit and loss (current value minus total entry value)""" - website_url: Optional[str] = None - """official website URL of the entity""" + website_url: str + """Official website URL""" diff --git a/src/coingecko_sdk/types/public_treasury_get_holding_chart_params.py b/src/coingecko_sdk/types/public_treasury_get_holding_chart_params.py index 3414f11..a7d0a1d 100644 --- a/src/coingecko_sdk/types/public_treasury_get_holding_chart_params.py +++ b/src/coingecko_sdk/types/public_treasury_get_holding_chart_params.py @@ -11,7 +11,10 @@ class PublicTreasuryGetHoldingChartParams(TypedDict, total=False): entity_id: Required[str] days: Required[str] - """data up to number of days ago Valid values: `7, 14, 30, 90, 180, 365, 730, max`""" + """Data up to number of days ago. + + Valid values: `7`, `14`, `30`, `90`, `180`, `365`, `730`, `max` + """ include_empty_intervals: bool - """include empty intervals with no transaction data, default: false""" + """Include empty intervals with no transaction data. Default: `false`""" diff --git a/src/coingecko_sdk/types/public_treasury_get_holding_chart_response.py b/src/coingecko_sdk/types/public_treasury_get_holding_chart_response.py index 1041331..2513cea 100644 --- a/src/coingecko_sdk/types/public_treasury_get_holding_chart_response.py +++ b/src/coingecko_sdk/types/public_treasury_get_holding_chart_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from .._models import BaseModel @@ -8,6 +8,8 @@ class PublicTreasuryGetHoldingChartResponse(BaseModel): - holding_value_in_usd: Optional[List[List[float]]] = None + holding_value_in_usd: List[List[float]] + """Historical holdings value in USD as [timestamp, value_usd] pairs""" - holdings: Optional[List[List[float]]] = None + holdings: List[List[float]] + """Historical holdings data as [timestamp, amount] pairs""" diff --git a/src/coingecko_sdk/types/public_treasury_get_transaction_history_params.py b/src/coingecko_sdk/types/public_treasury_get_transaction_history_params.py index b52fbae..a4e2464 100644 --- a/src/coingecko_sdk/types/public_treasury_get_transaction_history_params.py +++ b/src/coingecko_sdk/types/public_treasury_get_transaction_history_params.py @@ -9,8 +9,8 @@ class PublicTreasuryGetTransactionHistoryParams(TypedDict, total=False): coin_ids: str - """ - filter transactions by coin IDs, comma-separated if querying more than 1 coin + """Filter transactions by coin IDs, comma-separated if querying more than 1 coin. + \\**refers to [`/coins/list`](/reference/coins-list). """ @@ -24,10 +24,10 @@ class PublicTreasuryGetTransactionHistoryParams(TypedDict, total=False): "average_cost_desc", "average_cost_asc", ] - """use this to sort the order of transactions, default: `date_desc`""" + """Sort order of transactions. Default: `date_desc`""" - page: float - """page through results, default: `1`""" + page: int + """Page through results. Default value: 1""" - per_page: float - """total results per page, default: `100` Valid values: 1...250""" + per_page: int + """Total results per page. Default value: 100 Valid values: 1...250""" diff --git a/src/coingecko_sdk/types/public_treasury_get_transaction_history_response.py b/src/coingecko_sdk/types/public_treasury_get_transaction_history_response.py index e4a7124..498015f 100644 --- a/src/coingecko_sdk/types/public_treasury_get_transaction_history_response.py +++ b/src/coingecko_sdk/types/public_treasury_get_transaction_history_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import List from typing_extensions import Literal from .._models import BaseModel @@ -9,30 +9,30 @@ class Transaction(BaseModel): - average_entry_value_usd: Optional[float] = None - """average entry value in usd after the transaction""" + average_entry_value_usd: float + """Average entry value in USD after the transaction""" - coin_id: Optional[str] = None - """coin ID""" + coin_id: str + """Coin ID""" - date: Optional[float] = None - """transaction date in UNIX timestamp""" + date: float + """Transaction date in UNIX timestamp""" - holding_balance: Optional[float] = None - """total holding balance after the transaction""" + holding_balance: float + """Total holding balance after the transaction""" - holding_net_change: Optional[float] = None - """net change in holdings after the transaction""" + holding_net_change: float + """Net change in holdings after the transaction""" - source_url: Optional[str] = None - """source document URL""" + source_url: str + """Source document URL""" - transaction_value_usd: Optional[float] = None - """transaction value in usd""" + transaction_value_usd: float + """Transaction value in USD""" - type: Optional[Literal["buy", "sell"]] = None - """transaction type: buy or sell""" + type: Literal["buy", "sell"] + """Transaction type""" class PublicTreasuryGetTransactionHistoryResponse(BaseModel): - transactions: Optional[List[Transaction]] = None + transactions: List[Transaction] diff --git a/src/coingecko_sdk/types/search/trending_get_params.py b/src/coingecko_sdk/types/search/trending_get_params.py index d0ccf5b..a28db65 100644 --- a/src/coingecko_sdk/types/search/trending_get_params.py +++ b/src/coingecko_sdk/types/search/trending_get_params.py @@ -9,7 +9,8 @@ class TrendingGetParams(TypedDict, total=False): show_max: str - """ - show max number of results available for the given type Available values: - `coins`, `nfts`, `categories` Example: `coins` or `coins,nfts,categories` + """Show max number of results available for the given type. + + Available values: `coins`, `nfts`, `categories` e.g. `coins` or + `coins,nfts,categories` """ diff --git a/src/coingecko_sdk/types/search/trending_get_response.py b/src/coingecko_sdk/types/search/trending_get_response.py index ecf838e..a988852 100644 --- a/src/coingecko_sdk/types/search/trending_get_response.py +++ b/src/coingecko_sdk/types/search/trending_get_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import Dict, List, Optional from ..._models import BaseModel @@ -8,139 +8,131 @@ "TrendingGetResponse", "Category", "CategoryData", - "CategoryDataMarketCapChangePercentage24h", "Coin", - "CoinData", - "CoinDataContent", - "CoinDataPriceChangePercentage24h", + "CoinItem", + "CoinItemData", + "CoinItemDataContent", "NFT", "NFTData", "NFTDataContent", ] -class CategoryDataMarketCapChangePercentage24h(BaseModel): - """category market cap change percentage in 24 hours""" - - btc: Optional[float] = None - - usd: Optional[float] = None - - class CategoryData(BaseModel): - market_cap: Optional[float] = None - """category market cap""" + market_cap: float + """Category market cap""" - market_cap_btc: Optional[float] = None - """category market cap in btc""" + market_cap_btc: float + """Category market cap in BTC""" - market_cap_change_percentage_24h: Optional[CategoryDataMarketCapChangePercentage24h] = None - """category market cap change percentage in 24 hours""" + market_cap_change_percentage_24h: Dict[str, float] + """Category market cap change percentage in 24 hours by currency""" - sparkline: Optional[str] = None - """category sparkline image url""" + sparkline: str + """Category sparkline image URL""" - total_volume: Optional[float] = None - """category total volume""" + total_volume: float + """Category total volume""" - total_volume_btc: Optional[float] = None - """category total volume in btc""" + total_volume_btc: float + """Category total volume in BTC""" class Category(BaseModel): - id: Optional[float] = None + id: int + """Category ID""" + + coins_count: str + """Number of coins in the category""" - coins_count: Optional[float] = None - """category number of coins""" + data: CategoryData - data: Optional[CategoryData] = None + market_cap_1h_change: float + """Category market cap 1 hour change""" - market_cap_1h_change: Optional[float] = None - """category market cap 1 hour change""" + name: str + """Category name""" - name: Optional[str] = None - """category name""" + slug: str + """Category web slug""" - slug: Optional[str] = None - """category web slug""" + top_3_coins_images: List[str] + """Top 3 coins image URLs in the category""" -class CoinDataContent(BaseModel): +class CoinItemDataContent(BaseModel): description: Optional[str] = None title: Optional[str] = None -class CoinDataPriceChangePercentage24h(BaseModel): - """coin price change percentage in 24 hours""" +class CoinItemData(BaseModel): + content: Optional[CoinItemDataContent] = None - btc: Optional[float] = None + market_cap: str + """Coin market cap in USD""" - usd: Optional[float] = None + market_cap_btc: str + """Coin market cap in BTC""" + price: float + """Coin price in USD""" -class CoinData(BaseModel): - content: Optional[CoinDataContent] = None + price_btc: str + """Coin price in BTC""" - market_cap: Optional[str] = None - """coin market cap in usd""" + price_change_percentage_24h: Dict[str, float] + """Coin price change percentage in 24 hours by currency""" - market_cap_btc: Optional[str] = None - """coin market cap in btc""" + sparkline: str + """Coin sparkline image URL""" - price: Optional[float] = None - """coin price in usd""" + total_volume: str + """Coin total volume in USD""" - price_btc: Optional[str] = None - """coin price in btc""" + total_volume_btc: str + """Coin total volume in BTC""" - price_change_percentage_24h: Optional[CoinDataPriceChangePercentage24h] = None - """coin price change percentage in 24 hours""" - sparkline: Optional[str] = None - """coin sparkline image url""" +class CoinItem(BaseModel): + id: str + """Coin ID""" - total_volume: Optional[str] = None - """coin total volume in usd""" + coin_id: int + """Coin internal ID""" - total_volume_btc: Optional[str] = None - """coin total volume in btc""" + data: CoinItemData + large: str + """Coin large image URL""" -class Coin(BaseModel): - id: Optional[str] = None - """coin ID""" - - coin_id: Optional[float] = None + market_cap_rank: int + """Coin market cap rank""" - data: Optional[CoinData] = None + name: str + """Coin name""" - large: Optional[str] = None - """coin large image url""" + price_btc: float + """Coin price in BTC""" - market_cap_rank: Optional[float] = None - """coin market cap rank""" + score: int + """Coin trending rank (0-based)""" - name: Optional[str] = None - """coin name""" + slug: str + """Coin web slug""" - price_btc: Optional[float] = None - """coin price in btc""" + small: str + """Coin small image URL""" - score: Optional[float] = None - """coin sequence in the list""" + symbol: str + """Coin symbol""" - slug: Optional[str] = None - """coin web slug""" + thumb: str + """Coin thumb image URL""" - small: Optional[str] = None - """coin small image url""" - symbol: Optional[str] = None - """coin symbol""" - - thumb: Optional[str] = None - """coin thumb image url""" +class Coin(BaseModel): + item: CoinItem class NFTDataContent(BaseModel): @@ -152,52 +144,53 @@ class NFTDataContent(BaseModel): class NFTData(BaseModel): content: Optional[NFTDataContent] = None - floor_price: Optional[str] = None + floor_price: str """NFT collection floor price""" - floor_price_in_usd_24h_percentage_change: Optional[str] = None - """NFT collection floor price in usd 24 hours percentage change""" + floor_price_in_usd_24h_percentage_change: str + """NFT collection floor price in USD 24 hours percentage change""" - h24_average_sale_price: Optional[str] = None + h24_average_sale_price: str """NFT collection 24 hours average sale price""" - h24_volume: Optional[str] = None + h24_volume: str """NFT collection volume in 24 hours""" - sparkline: Optional[str] = None - """NFT collection sparkline image url""" + sparkline: str + """NFT collection sparkline image URL""" class NFT(BaseModel): - id: Optional[str] = None + id: str """NFT collection ID""" - data: Optional[NFTData] = None + data: NFTData - floor_price_24h_percentage_change: Optional[float] = None + floor_price_24h_percentage_change: float """NFT collection floor price 24 hours percentage change""" - floor_price_in_native_currency: Optional[float] = None + floor_price_in_native_currency: float """NFT collection floor price in native currency""" - name: Optional[str] = None + name: str """NFT collection name""" - native_currency_symbol: Optional[str] = None + native_currency_symbol: str """NFT collection native currency symbol""" - nft_contract_id: Optional[float] = None + nft_contract_id: int + """NFT contract internal ID""" - symbol: Optional[str] = None + symbol: str """NFT collection symbol""" - thumb: Optional[str] = None - """NFT collection thumb image url""" + thumb: str + """NFT collection thumb image URL""" class TrendingGetResponse(BaseModel): - categories: Optional[List[Category]] = None + categories: List[Category] - coins: Optional[List[Coin]] = None + coins: List[Coin] - nfts: Optional[List[NFT]] = None + nfts: List[NFT] diff --git a/src/coingecko_sdk/types/search_get_params.py b/src/coingecko_sdk/types/search_get_params.py index 0702950..94bd274 100644 --- a/src/coingecko_sdk/types/search_get_params.py +++ b/src/coingecko_sdk/types/search_get_params.py @@ -9,4 +9,4 @@ class SearchGetParams(TypedDict, total=False): query: Required[str] - """search query""" + """Search query""" diff --git a/src/coingecko_sdk/types/search_get_response.py b/src/coingecko_sdk/types/search_get_response.py index c81e689..f0666f3 100644 --- a/src/coingecko_sdk/types/search_get_response.py +++ b/src/coingecko_sdk/types/search_get_response.py @@ -4,78 +4,82 @@ from .._models import BaseModel -__all__ = ["SearchGetResponse", "Category", "Coin", "Exchange", "NFT"] +__all__ = ["SearchGetResponse", "Category", "Coin", "Exchange", "Ico", "NFT"] class Category(BaseModel): - id: Optional[str] = None - """category ID""" + id: str + """Category ID""" - name: Optional[str] = None - """category name""" + name: str + """Category name""" class Coin(BaseModel): - id: Optional[str] = None - """coin ID""" + id: str + """Coin ID""" - api_symbol: Optional[str] = None - """coin api symbol""" + api_symbol: str + """Coin API symbol""" - large: Optional[str] = None - """coin large image url""" + large: str + """Coin large image URL""" - market_cap_rank: Optional[float] = None - """coin market cap rank""" + market_cap_rank: Optional[int] = None + """Coin market cap rank""" - name: Optional[str] = None - """coin name""" + name: str + """Coin name""" - symbol: Optional[str] = None - """coin symbol""" + symbol: str + """Coin symbol""" - thumb: Optional[str] = None - """coin thumb image url""" + thumb: str + """Coin thumb image URL""" class Exchange(BaseModel): - id: Optional[str] = None - """exchange ID""" + id: str + """Exchange ID""" - large: Optional[str] = None - """exchange large image url""" + large: str + """Exchange large image URL""" - market_type: Optional[str] = None - """exchange market type""" + market_type: str + """Exchange market type""" - name: Optional[str] = None - """exchange name""" + name: str + """Exchange name""" - thumb: Optional[str] = None - """exchange thumb image url""" + thumb: str + """Exchange thumb image URL""" + + +class Ico(BaseModel): + pass class NFT(BaseModel): - id: Optional[str] = None + id: str """NFT collection ID""" - name: Optional[str] = None - """NFT name""" + name: str + """NFT collection name""" - symbol: Optional[str] = None + symbol: str """NFT collection symbol""" - thumb: Optional[str] = None - """NFT collection thumb image url""" + thumb: str + """NFT collection thumb image URL""" class SearchGetResponse(BaseModel): - categories: Optional[List[Category]] = None + categories: List[Category] - coins: Optional[List[Coin]] = None + coins: List[Coin] - exchanges: Optional[List[Exchange]] = None + exchanges: List[Exchange] - icos: Optional[List[str]] = None + icos: List[Ico] - nfts: Optional[List[NFT]] = None + nfts: List[NFT] diff --git a/src/coingecko_sdk/types/simple/price_get_params.py b/src/coingecko_sdk/types/simple/price_get_params.py index 76e29b2..b6990bb 100644 --- a/src/coingecko_sdk/types/simple/price_get_params.py +++ b/src/coingecko_sdk/types/simple/price_get_params.py @@ -9,43 +9,43 @@ class PriceGetParams(TypedDict, total=False): vs_currencies: Required[str] - """target currency of coins, comma-separated if querying more than 1 currency. + """Target currency of coins, comma-separated if querying more than 1 currency. \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) """ ids: str - """coins' IDs, comma-separated if querying more than 1 coin. + """Coins' IDs, comma-separated if querying more than 1 coin. - \\**refers to [`/coins/list`](/reference/coins-list). + \\**refers to [`/coins/list`](/reference/coins-list) """ include_24hr_change: bool - """include 24hr change percentage, default: false""" + """Include 24-hour change percentage. Default: false""" include_24hr_vol: bool - """include 24hr volume, default: false""" + """Include 24-hour trading volume. Default: false""" include_last_updated_at: bool - """include last updated price time in UNIX, default: false""" + """Include last updated price time as a UNIX timestamp. Default: false""" include_market_cap: bool - """include market capitalization, default: false""" + """Include market capitalization. Default: false""" include_tokens: Literal["top", "all"] - """ - for `symbols` lookups, specify `all` to include all matching tokens Default - `top` returns top-ranked tokens (by market cap or volume) + """For `symbols` lookups, specify `all` to include all matching tokens. + + Default `top` returns top-ranked tokens by market cap or volume. """ names: str - """coins' names, comma-separated if querying more than 1 coin.""" + """Coins' names, comma-separated if querying more than 1 coin.""" precision: Literal[ "full", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18" ] - """decimal place for currency price value""" + """Decimal places for currency price value""" symbols: str - """coins' symbols, comma-separated if querying more than 1 coin.""" + """Coins' symbols, comma-separated if querying more than 1 coin.""" diff --git a/src/coingecko_sdk/types/simple/price_get_response.py b/src/coingecko_sdk/types/simple/price_get_response.py index 021d756..668c514 100644 --- a/src/coingecko_sdk/types/simple/price_get_response.py +++ b/src/coingecko_sdk/types/simple/price_get_response.py @@ -10,19 +10,19 @@ class PriceGetResponseItem(BaseModel): last_updated_at: Optional[float] = None - """last updated timestamp""" + """Last updated timestamp in UNIX seconds""" usd: Optional[float] = None - """price in USD""" + """Price in the target currency""" usd_24h_change: Optional[float] = None - """24hr change percentage in USD""" + """24-hour price change percentage in the target currency""" usd_24h_vol: Optional[float] = None - """24hr volume in USD""" + """24-hour trading volume in the target currency""" usd_market_cap: Optional[float] = None - """market cap in USD""" + """Market capitalization in the target currency""" PriceGetResponse: TypeAlias = Dict[str, PriceGetResponseItem] diff --git a/src/coingecko_sdk/types/simple/token_price_get_id_params.py b/src/coingecko_sdk/types/simple/token_price_get_id_params.py index 3b3d3b1..283e442 100644 --- a/src/coingecko_sdk/types/simple/token_price_get_id_params.py +++ b/src/coingecko_sdk/types/simple/token_price_get_id_params.py @@ -9,31 +9,28 @@ class TokenPriceGetIDParams(TypedDict, total=False): contract_addresses: Required[str] - """ - the contract addresses of tokens, comma-separated if querying more than 1 - token's contract address - """ + """Token contract addresses, comma-separated if querying more than 1 token""" vs_currencies: Required[str] - """target currency of coins, comma-separated if querying more than 1 currency. + """Target currency of coins, comma-separated if querying more than 1 currency. \\**refers to - [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies). + [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies) """ include_24hr_change: bool - """include 24hr change default: false""" + """Include 24-hour change percentage. Default: false""" include_24hr_vol: bool - """include 24hr volume, default: false""" + """Include 24-hour trading volume. Default: false""" include_last_updated_at: bool - """include last updated price time in UNIX , default: false""" + """Include last updated price time as a UNIX timestamp. Default: false""" include_market_cap: bool - """include market capitalization, default: false""" + """Include market capitalization. Default: false""" precision: Literal[ "full", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18" ] - """decimal place for currency price value""" + """Decimal places for currency price value""" diff --git a/src/coingecko_sdk/types/simple/token_price_get_id_response.py b/src/coingecko_sdk/types/simple/token_price_get_id_response.py index b96dfee..0377dfd 100644 --- a/src/coingecko_sdk/types/simple/token_price_get_id_response.py +++ b/src/coingecko_sdk/types/simple/token_price_get_id_response.py @@ -1,24 +1,28 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import Optional +from typing import Dict, Optional +from typing_extensions import TypeAlias from ..._models import BaseModel -__all__ = ["TokenPriceGetIDResponse"] +__all__ = ["TokenPriceGetIDResponse", "TokenPriceGetIDResponseItem"] -class TokenPriceGetIDResponse(BaseModel): +class TokenPriceGetIDResponseItem(BaseModel): last_updated_at: Optional[float] = None - """last updated timestamp""" + """Last updated timestamp in UNIX seconds""" usd: Optional[float] = None - """price in USD""" + """Price in the target currency""" usd_24h_change: Optional[float] = None - """24hr change in USD""" + """24-hour price change percentage in the target currency""" usd_24h_vol: Optional[float] = None - """24hr volume in USD""" + """24-hour trading volume in the target currency""" usd_market_cap: Optional[float] = None - """market cap in USD""" + """Market capitalization in the target currency""" + + +TokenPriceGetIDResponse: TypeAlias = Dict[str, TokenPriceGetIDResponseItem] diff --git a/src/coingecko_sdk/types/token_list_get_all_json_response.py b/src/coingecko_sdk/types/token_list_get_all_json_response.py index f79fb11..c2368eb 100644 --- a/src/coingecko_sdk/types/token_list_get_all_json_response.py +++ b/src/coingecko_sdk/types/token_list_get_all_json_response.py @@ -11,45 +11,53 @@ class Token(BaseModel): - address: Optional[str] = None - """token contract address""" + address: str + """Token contract address""" - chain_id: Optional[float] = FieldInfo(alias="chainId", default=None) - """chainlist's chain ID""" + chain_id: float = FieldInfo(alias="chainId") + """Chainlist's chain ID""" - decimals: Optional[float] = None - """token decimals""" + decimals: float + """Token decimals""" - logo_uri: Optional[str] = FieldInfo(alias="logoURI", default=None) - """token image url""" + logo_uri: str = FieldInfo(alias="logoURI") + """Token image URL""" - name: Optional[str] = None - """token name""" + name: str + """Token name""" - symbol: Optional[str] = None - """token symbol""" + symbol: str + """Token symbol""" class Version(BaseModel): - """token list version""" + """Token list version""" major: Optional[float] = None + """Major version""" minor: Optional[float] = None + """Minor version""" patch: Optional[float] = None + """Patch version""" class TokenListGetAllJsonResponse(BaseModel): - keywords: Optional[List[str]] = None + keywords: List[str] + """Token list keywords""" - logo_uri: Optional[str] = FieldInfo(alias="logoURI", default=None) + logo_uri: str = FieldInfo(alias="logoURI") + """Token list logo URL""" - name: Optional[str] = None + name: str + """Token list name""" - timestamp: Optional[datetime] = None + timestamp: datetime + """Token list generation timestamp""" - tokens: Optional[List[Token]] = None + tokens: List[Token] + """List of tokens""" - version: Optional[Version] = None - """token list version""" + version: Version + """Token list version""" diff --git a/src/coingecko_sdk/types/treasury_entity.py b/src/coingecko_sdk/types/treasury_entity.py deleted file mode 100644 index d842f80..0000000 --- a/src/coingecko_sdk/types/treasury_entity.py +++ /dev/null @@ -1,30 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -from typing import Optional - -from .._models import BaseModel - -__all__ = ["TreasuryEntity"] - - -class TreasuryEntity(BaseModel): - country: Optional[str] = None - """company incorporated or government country""" - - name: Optional[str] = None - """company or government name""" - - percentage_of_total_supply: Optional[float] = None - """percentage of total crypto supply""" - - symbol: Optional[str] = None - """company symbol""" - - total_current_value_usd: Optional[float] = None - """total current value of crypto holdings in usd""" - - total_entry_value_usd: Optional[float] = None - """total entry value in usd""" - - total_holdings: Optional[float] = None - """total crypto holdings""" diff --git a/tests/api_resources/coins/contract/test_market_chart.py b/tests/api_resources/coins/contract/test_market_chart.py index 95bbf4d..edd26ea 100644 --- a/tests/api_resources/coins/contract/test_market_chart.py +++ b/tests/api_resources/coins/contract/test_market_chart.py @@ -24,10 +24,10 @@ class TestMarketChart: @parametrize def test_method_get(self, client: Coingecko) -> None: market_chart = client.coins.contract.market_chart.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketChartGetResponse, market_chart, path=["response"]) @@ -35,10 +35,10 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: market_chart = client.coins.contract.market_chart.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", interval="5m", precision="full", ) @@ -48,10 +48,10 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.contract.market_chart.with_raw_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -63,10 +63,10 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.contract.market_chart.with_streaming_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -81,29 +81,29 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): client.coins.contract.market_chart.with_raw_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", + contract_address="contract_address", id="", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): client.coins.contract.market_chart.with_raw_response.get( contract_address="", - id="ethereum", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) @pytest.mark.skip(reason="Mock server tests are disabled") @parametrize def test_method_get_range(self, client: Coingecko) -> None: market_chart = client.coins.contract.market_chart.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketChartGetRangeResponse, market_chart, path=["response"]) @@ -111,11 +111,11 @@ def test_method_get_range(self, client: Coingecko) -> None: @parametrize def test_method_get_range_with_all_params(self, client: Coingecko) -> None: market_chart = client.coins.contract.market_chart.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", interval="5m", precision="full", ) @@ -125,11 +125,11 @@ def test_method_get_range_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_range(self, client: Coingecko) -> None: response = client.coins.contract.market_chart.with_raw_response.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -141,11 +141,11 @@ def test_raw_response_get_range(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_range(self, client: Coingecko) -> None: with client.coins.contract.market_chart.with_streaming_response.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -160,20 +160,20 @@ def test_streaming_response_get_range(self, client: Coingecko) -> None: def test_path_params_get_range(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): client.coins.contract.market_chart.with_raw_response.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", + contract_address="contract_address", id="", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): client.coins.contract.market_chart.with_raw_response.get_range( contract_address="", - id="ethereum", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) @@ -186,10 +186,10 @@ class TestAsyncMarketChart: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.coins.contract.market_chart.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketChartGetResponse, market_chart, path=["response"]) @@ -197,10 +197,10 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.coins.contract.market_chart.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", interval="5m", precision="full", ) @@ -210,10 +210,10 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.contract.market_chart.with_raw_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -225,10 +225,10 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.contract.market_chart.with_streaming_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -243,29 +243,29 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): await async_client.coins.contract.market_chart.with_raw_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", + contract_address="contract_address", id="", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): await async_client.coins.contract.market_chart.with_raw_response.get( contract_address="", - id="ethereum", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) @pytest.mark.skip(reason="Mock server tests are disabled") @parametrize async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.coins.contract.market_chart.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketChartGetRangeResponse, market_chart, path=["response"]) @@ -273,11 +273,11 @@ async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_range_with_all_params(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.coins.contract.market_chart.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", interval="5m", precision="full", ) @@ -287,11 +287,11 @@ async def test_method_get_range_with_all_params(self, async_client: AsyncCoingec @parametrize async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.contract.market_chart.with_raw_response.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -303,11 +303,11 @@ async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_streaming_response_get_range(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.contract.market_chart.with_streaming_response.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -322,18 +322,18 @@ async def test_streaming_response_get_range(self, async_client: AsyncCoingecko) async def test_path_params_get_range(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): await async_client.coins.contract.market_chart.with_raw_response.get_range( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", + contract_address="contract_address", id="", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): await async_client.coins.contract.market_chart.with_raw_response.get_range( contract_address="", - id="ethereum", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) diff --git a/tests/api_resources/coins/test_circulating_supply_chart.py b/tests/api_resources/coins/test_circulating_supply_chart.py index 38ab5a5..3367084 100644 --- a/tests/api_resources/coins/test_circulating_supply_chart.py +++ b/tests/api_resources/coins/test_circulating_supply_chart.py @@ -24,7 +24,7 @@ class TestCirculatingSupplyChart: @parametrize def test_method_get(self, client: Coingecko) -> None: circulating_supply_chart = client.coins.circulating_supply_chart.get( - id="bitcoin", + id="id", days="days", ) assert_matches_type(CirculatingSupplyChartGetResponse, circulating_supply_chart, path=["response"]) @@ -33,7 +33,7 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: circulating_supply_chart = client.coins.circulating_supply_chart.get( - id="bitcoin", + id="id", days="days", interval="5m", ) @@ -43,7 +43,7 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.circulating_supply_chart.with_raw_response.get( - id="bitcoin", + id="id", days="days", ) @@ -56,7 +56,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.circulating_supply_chart.with_streaming_response.get( - id="bitcoin", + id="id", days="days", ) as response: assert not response.is_closed @@ -80,7 +80,7 @@ def test_path_params_get(self, client: Coingecko) -> None: @parametrize def test_method_get_range(self, client: Coingecko) -> None: circulating_supply_chart = client.coins.circulating_supply_chart.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) @@ -90,7 +90,7 @@ def test_method_get_range(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_range(self, client: Coingecko) -> None: response = client.coins.circulating_supply_chart.with_raw_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) @@ -104,7 +104,7 @@ def test_raw_response_get_range(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_range(self, client: Coingecko) -> None: with client.coins.circulating_supply_chart.with_streaming_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) as response: @@ -136,7 +136,7 @@ class TestAsyncCirculatingSupplyChart: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: circulating_supply_chart = await async_client.coins.circulating_supply_chart.get( - id="bitcoin", + id="id", days="days", ) assert_matches_type(CirculatingSupplyChartGetResponse, circulating_supply_chart, path=["response"]) @@ -145,7 +145,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: circulating_supply_chart = await async_client.coins.circulating_supply_chart.get( - id="bitcoin", + id="id", days="days", interval="5m", ) @@ -155,7 +155,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.circulating_supply_chart.with_raw_response.get( - id="bitcoin", + id="id", days="days", ) @@ -168,7 +168,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.circulating_supply_chart.with_streaming_response.get( - id="bitcoin", + id="id", days="days", ) as response: assert not response.is_closed @@ -192,7 +192,7 @@ async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: circulating_supply_chart = await async_client.coins.circulating_supply_chart.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) @@ -202,7 +202,7 @@ async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.circulating_supply_chart.with_raw_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) @@ -216,7 +216,7 @@ async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_streaming_response_get_range(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.circulating_supply_chart.with_streaming_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) as response: diff --git a/tests/api_resources/coins/test_contract.py b/tests/api_resources/coins/test_contract.py index 62c0708..dd17c16 100644 --- a/tests/api_resources/coins/test_contract.py +++ b/tests/api_resources/coins/test_contract.py @@ -21,8 +21,8 @@ class TestContract: @parametrize def test_method_get(self, client: Coingecko) -> None: contract = client.coins.contract.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", ) assert_matches_type(ContractGetResponse, contract, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.contract.with_raw_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", ) assert response.is_closed is True @@ -43,8 +43,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.contract.with_streaming_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -59,14 +59,14 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): client.coins.contract.with_raw_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", + contract_address="contract_address", id="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): client.coins.contract.with_raw_response.get( contract_address="", - id="ethereum", + id="id", ) @@ -79,8 +79,8 @@ class TestAsyncContract: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: contract = await async_client.coins.contract.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", ) assert_matches_type(ContractGetResponse, contract, path=["response"]) @@ -88,8 +88,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.contract.with_raw_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", ) assert response.is_closed is True @@ -101,8 +101,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.contract.with_streaming_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", - id="ethereum", + contract_address="contract_address", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -117,12 +117,12 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): await async_client.coins.contract.with_raw_response.get( - contract_address="0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", + contract_address="contract_address", id="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): await async_client.coins.contract.with_raw_response.get( contract_address="", - id="ethereum", + id="id", ) diff --git a/tests/api_resources/coins/test_history.py b/tests/api_resources/coins/test_history.py index 7fc8d58..3ac6f2b 100644 --- a/tests/api_resources/coins/test_history.py +++ b/tests/api_resources/coins/test_history.py @@ -21,7 +21,7 @@ class TestHistory: @parametrize def test_method_get(self, client: Coingecko) -> None: history = client.coins.history.get( - id="bitcoin", + id="id", date="date", ) assert_matches_type(HistoryGetResponse, history, path=["response"]) @@ -30,7 +30,7 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: history = client.coins.history.get( - id="bitcoin", + id="id", date="date", localization=True, ) @@ -40,7 +40,7 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.history.with_raw_response.get( - id="bitcoin", + id="id", date="date", ) @@ -53,7 +53,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.history.with_streaming_response.get( - id="bitcoin", + id="id", date="date", ) as response: assert not response.is_closed @@ -83,7 +83,7 @@ class TestAsyncHistory: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: history = await async_client.coins.history.get( - id="bitcoin", + id="id", date="date", ) assert_matches_type(HistoryGetResponse, history, path=["response"]) @@ -92,7 +92,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: history = await async_client.coins.history.get( - id="bitcoin", + id="id", date="date", localization=True, ) @@ -102,7 +102,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.history.with_raw_response.get( - id="bitcoin", + id="id", date="date", ) @@ -115,7 +115,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.history.with_streaming_response.get( - id="bitcoin", + id="id", date="date", ) as response: assert not response.is_closed diff --git a/tests/api_resources/coins/test_market_chart.py b/tests/api_resources/coins/test_market_chart.py index 170c3e1..8f22606 100644 --- a/tests/api_resources/coins/test_market_chart.py +++ b/tests/api_resources/coins/test_market_chart.py @@ -24,9 +24,9 @@ class TestMarketChart: @parametrize def test_method_get(self, client: Coingecko) -> None: market_chart = client.coins.market_chart.get( - id="bitcoin", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketChartGetResponse, market_chart, path=["response"]) @@ -34,9 +34,9 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: market_chart = client.coins.market_chart.get( - id="bitcoin", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", interval="5m", precision="full", ) @@ -46,9 +46,9 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.market_chart.with_raw_response.get( - id="bitcoin", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -60,9 +60,9 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.market_chart.with_streaming_response.get( - id="bitcoin", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -79,17 +79,17 @@ def test_path_params_get(self, client: Coingecko) -> None: client.coins.market_chart.with_raw_response.get( id="", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) @pytest.mark.skip(reason="Mock server tests are disabled") @parametrize def test_method_get_range(self, client: Coingecko) -> None: market_chart = client.coins.market_chart.get_range( - id="bitcoin", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketChartGetRangeResponse, market_chart, path=["response"]) @@ -97,10 +97,10 @@ def test_method_get_range(self, client: Coingecko) -> None: @parametrize def test_method_get_range_with_all_params(self, client: Coingecko) -> None: market_chart = client.coins.market_chart.get_range( - id="bitcoin", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", interval="5m", precision="full", ) @@ -110,10 +110,10 @@ def test_method_get_range_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_range(self, client: Coingecko) -> None: response = client.coins.market_chart.with_raw_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -125,10 +125,10 @@ def test_raw_response_get_range(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_range(self, client: Coingecko) -> None: with client.coins.market_chart.with_streaming_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -146,7 +146,7 @@ def test_path_params_get_range(self, client: Coingecko) -> None: id="", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) @@ -159,9 +159,9 @@ class TestAsyncMarketChart: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.coins.market_chart.get( - id="bitcoin", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketChartGetResponse, market_chart, path=["response"]) @@ -169,9 +169,9 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.coins.market_chart.get( - id="bitcoin", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", interval="5m", precision="full", ) @@ -181,9 +181,9 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.market_chart.with_raw_response.get( - id="bitcoin", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -195,9 +195,9 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.market_chart.with_streaming_response.get( - id="bitcoin", + id="id", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -214,17 +214,17 @@ async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: await async_client.coins.market_chart.with_raw_response.get( id="", days="days", - vs_currency="usd", + vs_currency="vs_currency", ) @pytest.mark.skip(reason="Mock server tests are disabled") @parametrize async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.coins.market_chart.get_range( - id="bitcoin", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketChartGetRangeResponse, market_chart, path=["response"]) @@ -232,10 +232,10 @@ async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_range_with_all_params(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.coins.market_chart.get_range( - id="bitcoin", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", interval="5m", precision="full", ) @@ -245,10 +245,10 @@ async def test_method_get_range_with_all_params(self, async_client: AsyncCoingec @parametrize async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.market_chart.with_raw_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -260,10 +260,10 @@ async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_streaming_response_get_range(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.market_chart.with_streaming_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -281,5 +281,5 @@ async def test_path_params_get_range(self, async_client: AsyncCoingecko) -> None id="", from_="from", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) diff --git a/tests/api_resources/coins/test_markets.py b/tests/api_resources/coins/test_markets.py index 31c09c7..9891270 100644 --- a/tests/api_resources/coins/test_markets.py +++ b/tests/api_resources/coins/test_markets.py @@ -21,7 +21,7 @@ class TestMarkets: @parametrize def test_method_get(self, client: Coingecko) -> None: market = client.coins.markets.get( - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketGetResponse, market, path=["response"]) @@ -29,8 +29,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: market = client.coins.markets.get( - vs_currency="usd", - category="layer-1", + vs_currency="vs_currency", + category="category", ids="ids", include_rehypothecated=True, include_tokens="top", @@ -50,7 +50,7 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.markets.with_raw_response.get( - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -62,7 +62,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.markets.with_streaming_response.get( - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -82,7 +82,7 @@ class TestAsyncMarkets: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: market = await async_client.coins.markets.get( - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketGetResponse, market, path=["response"]) @@ -90,8 +90,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: market = await async_client.coins.markets.get( - vs_currency="usd", - category="layer-1", + vs_currency="vs_currency", + category="category", ids="ids", include_rehypothecated=True, include_tokens="top", @@ -111,7 +111,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.markets.with_raw_response.get( - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -123,7 +123,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.markets.with_streaming_response.get( - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/coins/test_ohlc.py b/tests/api_resources/coins/test_ohlc.py index 96c2b55..7d5ccc0 100644 --- a/tests/api_resources/coins/test_ohlc.py +++ b/tests/api_resources/coins/test_ohlc.py @@ -21,9 +21,9 @@ class TestOhlc: @parametrize def test_method_get(self, client: Coingecko) -> None: ohlc = client.coins.ohlc.get( - id="bitcoin", + id="id", days="1", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(OhlcGetResponse, ohlc, path=["response"]) @@ -31,9 +31,9 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: ohlc = client.coins.ohlc.get( - id="bitcoin", + id="id", days="1", - vs_currency="usd", + vs_currency="vs_currency", interval="daily", precision="full", ) @@ -43,9 +43,9 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.ohlc.with_raw_response.get( - id="bitcoin", + id="id", days="1", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -57,9 +57,9 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.ohlc.with_streaming_response.get( - id="bitcoin", + id="id", days="1", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -76,18 +76,18 @@ def test_path_params_get(self, client: Coingecko) -> None: client.coins.ohlc.with_raw_response.get( id="", days="1", - vs_currency="usd", + vs_currency="vs_currency", ) @pytest.mark.skip(reason="Mock server tests are disabled") @parametrize def test_method_get_range(self, client: Coingecko) -> None: ohlc = client.coins.ohlc.get_range( - id="bitcoin", + id="id", from_="from", interval="daily", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(OhlcGetRangeResponse, ohlc, path=["response"]) @@ -95,11 +95,11 @@ def test_method_get_range(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_range(self, client: Coingecko) -> None: response = client.coins.ohlc.with_raw_response.get_range( - id="bitcoin", + id="id", from_="from", interval="daily", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -111,11 +111,11 @@ def test_raw_response_get_range(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_range(self, client: Coingecko) -> None: with client.coins.ohlc.with_streaming_response.get_range( - id="bitcoin", + id="id", from_="from", interval="daily", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -134,7 +134,7 @@ def test_path_params_get_range(self, client: Coingecko) -> None: from_="from", interval="daily", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) @@ -147,9 +147,9 @@ class TestAsyncOhlc: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: ohlc = await async_client.coins.ohlc.get( - id="bitcoin", + id="id", days="1", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(OhlcGetResponse, ohlc, path=["response"]) @@ -157,9 +157,9 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: ohlc = await async_client.coins.ohlc.get( - id="bitcoin", + id="id", days="1", - vs_currency="usd", + vs_currency="vs_currency", interval="daily", precision="full", ) @@ -169,9 +169,9 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.ohlc.with_raw_response.get( - id="bitcoin", + id="id", days="1", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -183,9 +183,9 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.ohlc.with_streaming_response.get( - id="bitcoin", + id="id", days="1", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -202,18 +202,18 @@ async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: await async_client.coins.ohlc.with_raw_response.get( id="", days="1", - vs_currency="usd", + vs_currency="vs_currency", ) @pytest.mark.skip(reason="Mock server tests are disabled") @parametrize async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: ohlc = await async_client.coins.ohlc.get_range( - id="bitcoin", + id="id", from_="from", interval="daily", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(OhlcGetRangeResponse, ohlc, path=["response"]) @@ -221,11 +221,11 @@ async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.ohlc.with_raw_response.get_range( - id="bitcoin", + id="id", from_="from", interval="daily", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -237,11 +237,11 @@ async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_streaming_response_get_range(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.ohlc.with_streaming_response.get_range( - id="bitcoin", + id="id", from_="from", interval="daily", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -260,5 +260,5 @@ async def test_path_params_get_range(self, async_client: AsyncCoingecko) -> None from_="from", interval="daily", to="to", - vs_currency="usd", + vs_currency="vs_currency", ) diff --git a/tests/api_resources/coins/test_tickers.py b/tests/api_resources/coins/test_tickers.py index 100230a..e059c2e 100644 --- a/tests/api_resources/coins/test_tickers.py +++ b/tests/api_resources/coins/test_tickers.py @@ -21,7 +21,7 @@ class TestTickers: @parametrize def test_method_get(self, client: Coingecko) -> None: ticker = client.coins.tickers.get( - id="bitcoin", + id="id", ) assert_matches_type(TickerGetResponse, ticker, path=["response"]) @@ -29,10 +29,10 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: ticker = client.coins.tickers.get( - id="bitcoin", + id="id", depth=True, dex_pair_format="contract_address", - exchange_ids="binance", + exchange_ids="exchange_ids", include_exchange_logo=True, order="trust_score_desc", page=0, @@ -43,7 +43,7 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.tickers.with_raw_response.get( - id="bitcoin", + id="id", ) assert response.is_closed is True @@ -55,7 +55,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.tickers.with_streaming_response.get( - id="bitcoin", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -83,7 +83,7 @@ class TestAsyncTickers: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: ticker = await async_client.coins.tickers.get( - id="bitcoin", + id="id", ) assert_matches_type(TickerGetResponse, ticker, path=["response"]) @@ -91,10 +91,10 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: ticker = await async_client.coins.tickers.get( - id="bitcoin", + id="id", depth=True, dex_pair_format="contract_address", - exchange_ids="binance", + exchange_ids="exchange_ids", include_exchange_logo=True, order="trust_score_desc", page=0, @@ -105,7 +105,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.tickers.with_raw_response.get( - id="bitcoin", + id="id", ) assert response.is_closed is True @@ -117,7 +117,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.tickers.with_streaming_response.get( - id="bitcoin", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/coins/test_top_gainers_losers.py b/tests/api_resources/coins/test_top_gainers_losers.py index 3e66024..6f0f462 100644 --- a/tests/api_resources/coins/test_top_gainers_losers.py +++ b/tests/api_resources/coins/test_top_gainers_losers.py @@ -21,7 +21,7 @@ class TestTopGainersLosers: @parametrize def test_method_get(self, client: Coingecko) -> None: top_gainers_loser = client.coins.top_gainers_losers.get( - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(TopGainersLoserGetResponse, top_gainers_loser, path=["response"]) @@ -29,7 +29,7 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: top_gainers_loser = client.coins.top_gainers_losers.get( - vs_currency="usd", + vs_currency="vs_currency", duration="1h", price_change_percentage="price_change_percentage", top_coins="300", @@ -40,7 +40,7 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.top_gainers_losers.with_raw_response.get( - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -52,7 +52,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.top_gainers_losers.with_streaming_response.get( - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -72,7 +72,7 @@ class TestAsyncTopGainersLosers: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: top_gainers_loser = await async_client.coins.top_gainers_losers.get( - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(TopGainersLoserGetResponse, top_gainers_loser, path=["response"]) @@ -80,7 +80,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: top_gainers_loser = await async_client.coins.top_gainers_losers.get( - vs_currency="usd", + vs_currency="vs_currency", duration="1h", price_change_percentage="price_change_percentage", top_coins="300", @@ -91,7 +91,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.top_gainers_losers.with_raw_response.get( - vs_currency="usd", + vs_currency="vs_currency", ) assert response.is_closed is True @@ -103,7 +103,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.top_gainers_losers.with_streaming_response.get( - vs_currency="usd", + vs_currency="vs_currency", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/coins/test_total_supply_chart.py b/tests/api_resources/coins/test_total_supply_chart.py index acbc9e1..313b142 100644 --- a/tests/api_resources/coins/test_total_supply_chart.py +++ b/tests/api_resources/coins/test_total_supply_chart.py @@ -24,7 +24,7 @@ class TestTotalSupplyChart: @parametrize def test_method_get(self, client: Coingecko) -> None: total_supply_chart = client.coins.total_supply_chart.get( - id="bitcoin", + id="id", days="days", ) assert_matches_type(TotalSupplyChartGetResponse, total_supply_chart, path=["response"]) @@ -33,7 +33,7 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: total_supply_chart = client.coins.total_supply_chart.get( - id="bitcoin", + id="id", days="days", interval="daily", ) @@ -43,7 +43,7 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.coins.total_supply_chart.with_raw_response.get( - id="bitcoin", + id="id", days="days", ) @@ -56,7 +56,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.coins.total_supply_chart.with_streaming_response.get( - id="bitcoin", + id="id", days="days", ) as response: assert not response.is_closed @@ -80,7 +80,7 @@ def test_path_params_get(self, client: Coingecko) -> None: @parametrize def test_method_get_range(self, client: Coingecko) -> None: total_supply_chart = client.coins.total_supply_chart.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) @@ -90,7 +90,7 @@ def test_method_get_range(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_range(self, client: Coingecko) -> None: response = client.coins.total_supply_chart.with_raw_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) @@ -104,7 +104,7 @@ def test_raw_response_get_range(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_range(self, client: Coingecko) -> None: with client.coins.total_supply_chart.with_streaming_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) as response: @@ -136,7 +136,7 @@ class TestAsyncTotalSupplyChart: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: total_supply_chart = await async_client.coins.total_supply_chart.get( - id="bitcoin", + id="id", days="days", ) assert_matches_type(TotalSupplyChartGetResponse, total_supply_chart, path=["response"]) @@ -145,7 +145,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: total_supply_chart = await async_client.coins.total_supply_chart.get( - id="bitcoin", + id="id", days="days", interval="daily", ) @@ -155,7 +155,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.total_supply_chart.with_raw_response.get( - id="bitcoin", + id="id", days="days", ) @@ -168,7 +168,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.total_supply_chart.with_streaming_response.get( - id="bitcoin", + id="id", days="days", ) as response: assert not response.is_closed @@ -192,7 +192,7 @@ async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: total_supply_chart = await async_client.coins.total_supply_chart.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) @@ -202,7 +202,7 @@ async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> None: response = await async_client.coins.total_supply_chart.with_raw_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) @@ -216,7 +216,7 @@ async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_streaming_response_get_range(self, async_client: AsyncCoingecko) -> None: async with async_client.coins.total_supply_chart.with_streaming_response.get_range( - id="bitcoin", + id="id", from_="from", to="to", ) as response: diff --git a/tests/api_resources/derivatives/test_exchanges.py b/tests/api_resources/derivatives/test_exchanges.py index 99a61bf..fb7d429 100644 --- a/tests/api_resources/derivatives/test_exchanges.py +++ b/tests/api_resources/derivatives/test_exchanges.py @@ -63,7 +63,7 @@ def test_streaming_response_get(self, client: Coingecko) -> None: @parametrize def test_method_get_id(self, client: Coingecko) -> None: exchange = client.derivatives.exchanges.get_id( - id="binance_futures", + id="id", ) assert_matches_type(ExchangeGetIDResponse, exchange, path=["response"]) @@ -71,7 +71,7 @@ def test_method_get_id(self, client: Coingecko) -> None: @parametrize def test_method_get_id_with_all_params(self, client: Coingecko) -> None: exchange = client.derivatives.exchanges.get_id( - id="binance_futures", + id="id", include_tickers="all", ) assert_matches_type(ExchangeGetIDResponse, exchange, path=["response"]) @@ -80,7 +80,7 @@ def test_method_get_id_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_id(self, client: Coingecko) -> None: response = client.derivatives.exchanges.with_raw_response.get_id( - id="binance_futures", + id="id", ) assert response.is_closed is True @@ -92,7 +92,7 @@ def test_raw_response_get_id(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_id(self, client: Coingecko) -> None: with client.derivatives.exchanges.with_streaming_response.get_id( - id="binance_futures", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -186,7 +186,7 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_method_get_id(self, async_client: AsyncCoingecko) -> None: exchange = await async_client.derivatives.exchanges.get_id( - id="binance_futures", + id="id", ) assert_matches_type(ExchangeGetIDResponse, exchange, path=["response"]) @@ -194,7 +194,7 @@ async def test_method_get_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_id_with_all_params(self, async_client: AsyncCoingecko) -> None: exchange = await async_client.derivatives.exchanges.get_id( - id="binance_futures", + id="id", include_tickers="all", ) assert_matches_type(ExchangeGetIDResponse, exchange, path=["response"]) @@ -203,7 +203,7 @@ async def test_method_get_id_with_all_params(self, async_client: AsyncCoingecko) @parametrize async def test_raw_response_get_id(self, async_client: AsyncCoingecko) -> None: response = await async_client.derivatives.exchanges.with_raw_response.get_id( - id="binance_futures", + id="id", ) assert response.is_closed is True @@ -215,7 +215,7 @@ async def test_raw_response_get_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get_id(self, async_client: AsyncCoingecko) -> None: async with async_client.derivatives.exchanges.with_streaming_response.get_id( - id="binance_futures", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/exchanges/test_tickers.py b/tests/api_resources/exchanges/test_tickers.py index 6814b4c..ab9a30b 100644 --- a/tests/api_resources/exchanges/test_tickers.py +++ b/tests/api_resources/exchanges/test_tickers.py @@ -21,7 +21,7 @@ class TestTickers: @parametrize def test_method_get(self, client: Coingecko) -> None: ticker = client.exchanges.tickers.get( - id="binance", + id="id", ) assert_matches_type(TickerGetResponse, ticker, path=["response"]) @@ -29,7 +29,7 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: ticker = client.exchanges.tickers.get( - id="binance", + id="id", coin_ids="coin_ids", depth=True, dex_pair_format="contract_address", @@ -43,7 +43,7 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.exchanges.tickers.with_raw_response.get( - id="binance", + id="id", ) assert response.is_closed is True @@ -55,7 +55,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.exchanges.tickers.with_streaming_response.get( - id="binance", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -83,7 +83,7 @@ class TestAsyncTickers: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: ticker = await async_client.exchanges.tickers.get( - id="binance", + id="id", ) assert_matches_type(TickerGetResponse, ticker, path=["response"]) @@ -91,7 +91,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: ticker = await async_client.exchanges.tickers.get( - id="binance", + id="id", coin_ids="coin_ids", depth=True, dex_pair_format="contract_address", @@ -105,7 +105,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.exchanges.tickers.with_raw_response.get( - id="binance", + id="id", ) assert response.is_closed is True @@ -117,7 +117,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.exchanges.tickers.with_streaming_response.get( - id="binance", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/exchanges/test_volume_chart.py b/tests/api_resources/exchanges/test_volume_chart.py index 488ea19..3fe01cf 100644 --- a/tests/api_resources/exchanges/test_volume_chart.py +++ b/tests/api_resources/exchanges/test_volume_chart.py @@ -71,8 +71,8 @@ def test_path_params_get(self, client: Coingecko) -> None: def test_method_get_range(self, client: Coingecko) -> None: volume_chart = client.exchanges.volume_chart.get_range( id="id", - from_=1672531200, - to=1675123200, + from_=0, + to=0, ) assert_matches_type(VolumeChartGetRangeResponse, volume_chart, path=["response"]) @@ -81,8 +81,8 @@ def test_method_get_range(self, client: Coingecko) -> None: def test_raw_response_get_range(self, client: Coingecko) -> None: response = client.exchanges.volume_chart.with_raw_response.get_range( id="id", - from_=1672531200, - to=1675123200, + from_=0, + to=0, ) assert response.is_closed is True @@ -95,8 +95,8 @@ def test_raw_response_get_range(self, client: Coingecko) -> None: def test_streaming_response_get_range(self, client: Coingecko) -> None: with client.exchanges.volume_chart.with_streaming_response.get_range( id="id", - from_=1672531200, - to=1675123200, + from_=0, + to=0, ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -112,8 +112,8 @@ def test_path_params_get_range(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): client.exchanges.volume_chart.with_raw_response.get_range( id="", - from_=1672531200, - to=1675123200, + from_=0, + to=0, ) @@ -173,8 +173,8 @@ async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: volume_chart = await async_client.exchanges.volume_chart.get_range( id="id", - from_=1672531200, - to=1675123200, + from_=0, + to=0, ) assert_matches_type(VolumeChartGetRangeResponse, volume_chart, path=["response"]) @@ -183,8 +183,8 @@ async def test_method_get_range(self, async_client: AsyncCoingecko) -> None: async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> None: response = await async_client.exchanges.volume_chart.with_raw_response.get_range( id="id", - from_=1672531200, - to=1675123200, + from_=0, + to=0, ) assert response.is_closed is True @@ -197,8 +197,8 @@ async def test_raw_response_get_range(self, async_client: AsyncCoingecko) -> Non async def test_streaming_response_get_range(self, async_client: AsyncCoingecko) -> None: async with async_client.exchanges.volume_chart.with_streaming_response.get_range( id="id", - from_=1672531200, - to=1675123200, + from_=0, + to=0, ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -214,6 +214,6 @@ async def test_path_params_get_range(self, async_client: AsyncCoingecko) -> None with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): await async_client.exchanges.volume_chart.with_raw_response.get_range( id="", - from_=1672531200, - to=1675123200, + from_=0, + to=0, ) diff --git a/tests/api_resources/global_/test_market_cap_chart.py b/tests/api_resources/global_/test_market_cap_chart.py index 61491a4..8f85d40 100644 --- a/tests/api_resources/global_/test_market_cap_chart.py +++ b/tests/api_resources/global_/test_market_cap_chart.py @@ -30,7 +30,7 @@ def test_method_get(self, client: Coingecko) -> None: def test_method_get_with_all_params(self, client: Coingecko) -> None: market_cap_chart = client.global_.market_cap_chart.get( days="1", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketCapChartGetResponse, market_cap_chart, path=["response"]) @@ -79,7 +79,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: market_cap_chart = await async_client.global_.market_cap_chart.get( days="1", - vs_currency="usd", + vs_currency="vs_currency", ) assert_matches_type(MarketCapChartGetResponse, market_cap_chart, path=["response"]) diff --git a/tests/api_resources/nfts/contract/test_market_chart.py b/tests/api_resources/nfts/contract/test_market_chart.py index 3d9f6a0..aee83d1 100644 --- a/tests/api_resources/nfts/contract/test_market_chart.py +++ b/tests/api_resources/nfts/contract/test_market_chart.py @@ -21,8 +21,8 @@ class TestMarketChart: @parametrize def test_method_get(self, client: Coingecko) -> None: market_chart = client.nfts.contract.market_chart.get( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", days="days", ) assert_matches_type(MarketChartGetResponse, market_chart, path=["response"]) @@ -31,8 +31,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.nfts.contract.market_chart.with_raw_response.get( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", days="days", ) @@ -45,8 +45,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.nfts.contract.market_chart.with_streaming_response.get( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", days="days", ) as response: assert not response.is_closed @@ -62,7 +62,7 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `asset_platform_id` but received ''"): client.nfts.contract.market_chart.with_raw_response.get( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", + contract_address="contract_address", asset_platform_id="", days="days", ) @@ -70,7 +70,7 @@ def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): client.nfts.contract.market_chart.with_raw_response.get( contract_address="", - asset_platform_id="ethereum", + asset_platform_id="asset_platform_id", days="days", ) @@ -84,8 +84,8 @@ class TestAsyncMarketChart: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.nfts.contract.market_chart.get( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", days="days", ) assert_matches_type(MarketChartGetResponse, market_chart, path=["response"]) @@ -94,8 +94,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.nfts.contract.market_chart.with_raw_response.get( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", days="days", ) @@ -108,8 +108,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.nfts.contract.market_chart.with_streaming_response.get( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", days="days", ) as response: assert not response.is_closed @@ -125,7 +125,7 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `asset_platform_id` but received ''"): await async_client.nfts.contract.market_chart.with_raw_response.get( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", + contract_address="contract_address", asset_platform_id="", days="days", ) @@ -133,6 +133,6 @@ async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): await async_client.nfts.contract.market_chart.with_raw_response.get( contract_address="", - asset_platform_id="ethereum", + asset_platform_id="asset_platform_id", days="days", ) diff --git a/tests/api_resources/nfts/test_contract.py b/tests/api_resources/nfts/test_contract.py index 734dd18..ebb1a10 100644 --- a/tests/api_resources/nfts/test_contract.py +++ b/tests/api_resources/nfts/test_contract.py @@ -21,8 +21,8 @@ class TestContract: @parametrize def test_method_get_contract_address(self, client: Coingecko) -> None: contract = client.nfts.contract.get_contract_address( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", ) assert_matches_type(ContractGetContractAddressResponse, contract, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get_contract_address(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_contract_address(self, client: Coingecko) -> None: response = client.nfts.contract.with_raw_response.get_contract_address( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", ) assert response.is_closed is True @@ -43,8 +43,8 @@ def test_raw_response_get_contract_address(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_contract_address(self, client: Coingecko) -> None: with client.nfts.contract.with_streaming_response.get_contract_address( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -59,14 +59,14 @@ def test_streaming_response_get_contract_address(self, client: Coingecko) -> Non def test_path_params_get_contract_address(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `asset_platform_id` but received ''"): client.nfts.contract.with_raw_response.get_contract_address( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", + contract_address="contract_address", asset_platform_id="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): client.nfts.contract.with_raw_response.get_contract_address( contract_address="", - asset_platform_id="ethereum", + asset_platform_id="asset_platform_id", ) @@ -79,8 +79,8 @@ class TestAsyncContract: @parametrize async def test_method_get_contract_address(self, async_client: AsyncCoingecko) -> None: contract = await async_client.nfts.contract.get_contract_address( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", ) assert_matches_type(ContractGetContractAddressResponse, contract, path=["response"]) @@ -88,8 +88,8 @@ async def test_method_get_contract_address(self, async_client: AsyncCoingecko) - @parametrize async def test_raw_response_get_contract_address(self, async_client: AsyncCoingecko) -> None: response = await async_client.nfts.contract.with_raw_response.get_contract_address( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", ) assert response.is_closed is True @@ -101,8 +101,8 @@ async def test_raw_response_get_contract_address(self, async_client: AsyncCoinge @parametrize async def test_streaming_response_get_contract_address(self, async_client: AsyncCoingecko) -> None: async with async_client.nfts.contract.with_streaming_response.get_contract_address( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", - asset_platform_id="ethereum", + contract_address="contract_address", + asset_platform_id="asset_platform_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -117,12 +117,12 @@ async def test_streaming_response_get_contract_address(self, async_client: Async async def test_path_params_get_contract_address(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `asset_platform_id` but received ''"): await async_client.nfts.contract.with_raw_response.get_contract_address( - contract_address="0xBd3531dA5CF5857e7CfAA92426877b022e612cf8", + contract_address="contract_address", asset_platform_id="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `contract_address` but received ''"): await async_client.nfts.contract.with_raw_response.get_contract_address( contract_address="", - asset_platform_id="ethereum", + asset_platform_id="asset_platform_id", ) diff --git a/tests/api_resources/nfts/test_market_chart.py b/tests/api_resources/nfts/test_market_chart.py index 30334d8..838909c 100644 --- a/tests/api_resources/nfts/test_market_chart.py +++ b/tests/api_resources/nfts/test_market_chart.py @@ -21,7 +21,7 @@ class TestMarketChart: @parametrize def test_method_get(self, client: Coingecko) -> None: market_chart = client.nfts.market_chart.get( - id="pudgy-penguins", + id="id", days="days", ) assert_matches_type(MarketChartGetResponse, market_chart, path=["response"]) @@ -30,7 +30,7 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.nfts.market_chart.with_raw_response.get( - id="pudgy-penguins", + id="id", days="days", ) @@ -43,7 +43,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.nfts.market_chart.with_streaming_response.get( - id="pudgy-penguins", + id="id", days="days", ) as response: assert not response.is_closed @@ -73,7 +73,7 @@ class TestAsyncMarketChart: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: market_chart = await async_client.nfts.market_chart.get( - id="pudgy-penguins", + id="id", days="days", ) assert_matches_type(MarketChartGetResponse, market_chart, path=["response"]) @@ -82,7 +82,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.nfts.market_chart.with_raw_response.get( - id="pudgy-penguins", + id="id", days="days", ) @@ -95,7 +95,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.nfts.market_chart.with_streaming_response.get( - id="pudgy-penguins", + id="id", days="days", ) as response: assert not response.is_closed diff --git a/tests/api_resources/nfts/test_tickers.py b/tests/api_resources/nfts/test_tickers.py index 9fbbb1d..1637c42 100644 --- a/tests/api_resources/nfts/test_tickers.py +++ b/tests/api_resources/nfts/test_tickers.py @@ -21,7 +21,7 @@ class TestTickers: @parametrize def test_method_get(self, client: Coingecko) -> None: ticker = client.nfts.tickers.get( - "pudgy-penguins", + "id", ) assert_matches_type(TickerGetResponse, ticker, path=["response"]) @@ -29,7 +29,7 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.nfts.tickers.with_raw_response.get( - "pudgy-penguins", + "id", ) assert response.is_closed is True @@ -41,7 +41,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.nfts.tickers.with_streaming_response.get( - "pudgy-penguins", + "id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -69,7 +69,7 @@ class TestAsyncTickers: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: ticker = await async_client.nfts.tickers.get( - "pudgy-penguins", + "id", ) assert_matches_type(TickerGetResponse, ticker, path=["response"]) @@ -77,7 +77,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.nfts.tickers.with_raw_response.get( - "pudgy-penguins", + "id", ) assert response.is_closed is True @@ -89,7 +89,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.nfts.tickers.with_streaming_response.get( - "pudgy-penguins", + "id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/onchain/networks/pools/test_info.py b/tests/api_resources/onchain/networks/pools/test_info.py index 6c28a0a..9ad62e5 100644 --- a/tests/api_resources/onchain/networks/pools/test_info.py +++ b/tests/api_resources/onchain/networks/pools/test_info.py @@ -21,8 +21,8 @@ class TestInfo: @parametrize def test_method_get(self, client: Coingecko) -> None: info = client.onchain.networks.pools.info.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) assert_matches_type(InfoGetResponse, info, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: info = client.onchain.networks.pools.info.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", include="pool", ) assert_matches_type(InfoGetResponse, info, path=["response"]) @@ -40,8 +40,8 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.pools.info.with_raw_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) assert response.is_closed is True @@ -53,8 +53,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.pools.info.with_streaming_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -69,14 +69,14 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.pools.info.with_raw_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + pool_address="pool_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `pool_address` but received ''"): client.onchain.networks.pools.info.with_raw_response.get( pool_address="", - network="eth", + network="network", ) @@ -89,8 +89,8 @@ class TestAsyncInfo: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: info = await async_client.onchain.networks.pools.info.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) assert_matches_type(InfoGetResponse, info, path=["response"]) @@ -98,8 +98,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: info = await async_client.onchain.networks.pools.info.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", include="pool", ) assert_matches_type(InfoGetResponse, info, path=["response"]) @@ -108,8 +108,8 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.pools.info.with_raw_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) assert response.is_closed is True @@ -121,8 +121,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.pools.info.with_streaming_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -137,12 +137,12 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.pools.info.with_raw_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + pool_address="pool_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `pool_address` but received ''"): await async_client.onchain.networks.pools.info.with_raw_response.get( pool_address="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/networks/pools/test_multi.py b/tests/api_resources/onchain/networks/pools/test_multi.py index 1d44ba5..2e81a11 100644 --- a/tests/api_resources/onchain/networks/pools/test_multi.py +++ b/tests/api_resources/onchain/networks/pools/test_multi.py @@ -22,7 +22,7 @@ class TestMulti: def test_method_get_addresses(self, client: Coingecko) -> None: multi = client.onchain.networks.pools.multi.get_addresses( addresses="addresses", - network="eth", + network="network", ) assert_matches_type(MultiGetAddressesResponse, multi, path=["response"]) @@ -31,7 +31,7 @@ def test_method_get_addresses(self, client: Coingecko) -> None: def test_method_get_addresses_with_all_params(self, client: Coingecko) -> None: multi = client.onchain.networks.pools.multi.get_addresses( addresses="addresses", - network="eth", + network="network", include="include", include_composition=True, include_volume_breakdown=True, @@ -43,7 +43,7 @@ def test_method_get_addresses_with_all_params(self, client: Coingecko) -> None: def test_raw_response_get_addresses(self, client: Coingecko) -> None: response = client.onchain.networks.pools.multi.with_raw_response.get_addresses( addresses="addresses", - network="eth", + network="network", ) assert response.is_closed is True @@ -56,7 +56,7 @@ def test_raw_response_get_addresses(self, client: Coingecko) -> None: def test_streaming_response_get_addresses(self, client: Coingecko) -> None: with client.onchain.networks.pools.multi.with_streaming_response.get_addresses( addresses="addresses", - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -78,7 +78,7 @@ def test_path_params_get_addresses(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `addresses` but received ''"): client.onchain.networks.pools.multi.with_raw_response.get_addresses( addresses="", - network="eth", + network="network", ) @@ -92,7 +92,7 @@ class TestAsyncMulti: async def test_method_get_addresses(self, async_client: AsyncCoingecko) -> None: multi = await async_client.onchain.networks.pools.multi.get_addresses( addresses="addresses", - network="eth", + network="network", ) assert_matches_type(MultiGetAddressesResponse, multi, path=["response"]) @@ -101,7 +101,7 @@ async def test_method_get_addresses(self, async_client: AsyncCoingecko) -> None: async def test_method_get_addresses_with_all_params(self, async_client: AsyncCoingecko) -> None: multi = await async_client.onchain.networks.pools.multi.get_addresses( addresses="addresses", - network="eth", + network="network", include="include", include_composition=True, include_volume_breakdown=True, @@ -113,7 +113,7 @@ async def test_method_get_addresses_with_all_params(self, async_client: AsyncCoi async def test_raw_response_get_addresses(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.pools.multi.with_raw_response.get_addresses( addresses="addresses", - network="eth", + network="network", ) assert response.is_closed is True @@ -126,7 +126,7 @@ async def test_raw_response_get_addresses(self, async_client: AsyncCoingecko) -> async def test_streaming_response_get_addresses(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.pools.multi.with_streaming_response.get_addresses( addresses="addresses", - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -148,5 +148,5 @@ async def test_path_params_get_addresses(self, async_client: AsyncCoingecko) -> with pytest.raises(ValueError, match=r"Expected a non-empty value for `addresses` but received ''"): await async_client.onchain.networks.pools.multi.with_raw_response.get_addresses( addresses="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/networks/pools/test_ohlcv.py b/tests/api_resources/onchain/networks/pools/test_ohlcv.py index 69b37e3..6bcfc62 100644 --- a/tests/api_resources/onchain/networks/pools/test_ohlcv.py +++ b/tests/api_resources/onchain/networks/pools/test_ohlcv.py @@ -22,8 +22,8 @@ class TestOhlcv: def test_method_get_timeframe(self, client: Coingecko) -> None: ohlcv = client.onchain.networks.pools.ohlcv.get_timeframe( timeframe="day", - network="eth", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + network="network", + pool_address="pool_address", ) assert_matches_type(OhlcvGetTimeframeResponse, ohlcv, path=["response"]) @@ -32,8 +32,8 @@ def test_method_get_timeframe(self, client: Coingecko) -> None: def test_method_get_timeframe_with_all_params(self, client: Coingecko) -> None: ohlcv = client.onchain.networks.pools.ohlcv.get_timeframe( timeframe="day", - network="eth", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + network="network", + pool_address="pool_address", token="token", aggregate="aggregate", before_timestamp=0, @@ -48,8 +48,8 @@ def test_method_get_timeframe_with_all_params(self, client: Coingecko) -> None: def test_raw_response_get_timeframe(self, client: Coingecko) -> None: response = client.onchain.networks.pools.ohlcv.with_raw_response.get_timeframe( timeframe="day", - network="eth", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + network="network", + pool_address="pool_address", ) assert response.is_closed is True @@ -62,8 +62,8 @@ def test_raw_response_get_timeframe(self, client: Coingecko) -> None: def test_streaming_response_get_timeframe(self, client: Coingecko) -> None: with client.onchain.networks.pools.ohlcv.with_streaming_response.get_timeframe( timeframe="day", - network="eth", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + network="network", + pool_address="pool_address", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -80,13 +80,13 @@ def test_path_params_get_timeframe(self, client: Coingecko) -> None: client.onchain.networks.pools.ohlcv.with_raw_response.get_timeframe( timeframe="day", network="", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + pool_address="pool_address", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `pool_address` but received ''"): client.onchain.networks.pools.ohlcv.with_raw_response.get_timeframe( timeframe="day", - network="eth", + network="network", pool_address="", ) @@ -101,8 +101,8 @@ class TestAsyncOhlcv: async def test_method_get_timeframe(self, async_client: AsyncCoingecko) -> None: ohlcv = await async_client.onchain.networks.pools.ohlcv.get_timeframe( timeframe="day", - network="eth", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + network="network", + pool_address="pool_address", ) assert_matches_type(OhlcvGetTimeframeResponse, ohlcv, path=["response"]) @@ -111,8 +111,8 @@ async def test_method_get_timeframe(self, async_client: AsyncCoingecko) -> None: async def test_method_get_timeframe_with_all_params(self, async_client: AsyncCoingecko) -> None: ohlcv = await async_client.onchain.networks.pools.ohlcv.get_timeframe( timeframe="day", - network="eth", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + network="network", + pool_address="pool_address", token="token", aggregate="aggregate", before_timestamp=0, @@ -127,8 +127,8 @@ async def test_method_get_timeframe_with_all_params(self, async_client: AsyncCoi async def test_raw_response_get_timeframe(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.pools.ohlcv.with_raw_response.get_timeframe( timeframe="day", - network="eth", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + network="network", + pool_address="pool_address", ) assert response.is_closed is True @@ -141,8 +141,8 @@ async def test_raw_response_get_timeframe(self, async_client: AsyncCoingecko) -> async def test_streaming_response_get_timeframe(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.pools.ohlcv.with_streaming_response.get_timeframe( timeframe="day", - network="eth", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + network="network", + pool_address="pool_address", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -159,12 +159,12 @@ async def test_path_params_get_timeframe(self, async_client: AsyncCoingecko) -> await async_client.onchain.networks.pools.ohlcv.with_raw_response.get_timeframe( timeframe="day", network="", - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + pool_address="pool_address", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `pool_address` but received ''"): await async_client.onchain.networks.pools.ohlcv.with_raw_response.get_timeframe( timeframe="day", - network="eth", + network="network", pool_address="", ) diff --git a/tests/api_resources/onchain/networks/pools/test_trades.py b/tests/api_resources/onchain/networks/pools/test_trades.py index dffd89e..de2a1a8 100644 --- a/tests/api_resources/onchain/networks/pools/test_trades.py +++ b/tests/api_resources/onchain/networks/pools/test_trades.py @@ -21,8 +21,8 @@ class TestTrades: @parametrize def test_method_get(self, client: Coingecko) -> None: trade = client.onchain.networks.pools.trades.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) assert_matches_type(TradeGetResponse, trade, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: trade = client.onchain.networks.pools.trades.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", token="token", trade_volume_in_usd_greater_than=0, ) @@ -41,8 +41,8 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.pools.trades.with_raw_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) assert response.is_closed is True @@ -54,8 +54,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.pools.trades.with_streaming_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -70,14 +70,14 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.pools.trades.with_raw_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + pool_address="pool_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `pool_address` but received ''"): client.onchain.networks.pools.trades.with_raw_response.get( pool_address="", - network="eth", + network="network", ) @@ -90,8 +90,8 @@ class TestAsyncTrades: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: trade = await async_client.onchain.networks.pools.trades.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) assert_matches_type(TradeGetResponse, trade, path=["response"]) @@ -99,8 +99,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: trade = await async_client.onchain.networks.pools.trades.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", token="token", trade_volume_in_usd_greater_than=0, ) @@ -110,8 +110,8 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.pools.trades.with_raw_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) assert response.is_closed is True @@ -123,8 +123,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.pools.trades.with_streaming_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", - network="eth", + pool_address="pool_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -139,12 +139,12 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.pools.trades.with_raw_response.get( - pool_address="0x06da0fd433c1a5d7a4faa01111c044910a184553", + pool_address="pool_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `pool_address` but received ''"): await async_client.onchain.networks.pools.trades.with_raw_response.get( pool_address="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/networks/test_dexes.py b/tests/api_resources/onchain/networks/test_dexes.py index 5bc3c78..17451c1 100644 --- a/tests/api_resources/onchain/networks/test_dexes.py +++ b/tests/api_resources/onchain/networks/test_dexes.py @@ -24,7 +24,7 @@ class TestDexes: @parametrize def test_method_get(self, client: Coingecko) -> None: dex = client.onchain.networks.dexes.get( - network="eth", + network="network", ) assert_matches_type(DexGetResponse, dex, path=["response"]) @@ -32,7 +32,7 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: dex = client.onchain.networks.dexes.get( - network="eth", + network="network", page=0, ) assert_matches_type(DexGetResponse, dex, path=["response"]) @@ -41,7 +41,7 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.dexes.with_raw_response.get( - network="eth", + network="network", ) assert response.is_closed is True @@ -53,7 +53,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.dexes.with_streaming_response.get( - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -75,8 +75,8 @@ def test_path_params_get(self, client: Coingecko) -> None: @parametrize def test_method_get_pools(self, client: Coingecko) -> None: dex = client.onchain.networks.dexes.get_pools( - dex="sushiswap", - network="eth", + dex="dex", + network="network", ) assert_matches_type(DexGetPoolsResponse, dex, path=["response"]) @@ -84,8 +84,8 @@ def test_method_get_pools(self, client: Coingecko) -> None: @parametrize def test_method_get_pools_with_all_params(self, client: Coingecko) -> None: dex = client.onchain.networks.dexes.get_pools( - dex="sushiswap", - network="eth", + dex="dex", + network="network", include="include", include_gt_community_data=True, page=0, @@ -97,8 +97,8 @@ def test_method_get_pools_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_pools(self, client: Coingecko) -> None: response = client.onchain.networks.dexes.with_raw_response.get_pools( - dex="sushiswap", - network="eth", + dex="dex", + network="network", ) assert response.is_closed is True @@ -110,8 +110,8 @@ def test_raw_response_get_pools(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_pools(self, client: Coingecko) -> None: with client.onchain.networks.dexes.with_streaming_response.get_pools( - dex="sushiswap", - network="eth", + dex="dex", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -126,14 +126,14 @@ def test_streaming_response_get_pools(self, client: Coingecko) -> None: def test_path_params_get_pools(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.dexes.with_raw_response.get_pools( - dex="sushiswap", + dex="dex", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `dex` but received ''"): client.onchain.networks.dexes.with_raw_response.get_pools( dex="", - network="eth", + network="network", ) @@ -146,7 +146,7 @@ class TestAsyncDexes: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: dex = await async_client.onchain.networks.dexes.get( - network="eth", + network="network", ) assert_matches_type(DexGetResponse, dex, path=["response"]) @@ -154,7 +154,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: dex = await async_client.onchain.networks.dexes.get( - network="eth", + network="network", page=0, ) assert_matches_type(DexGetResponse, dex, path=["response"]) @@ -163,7 +163,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.dexes.with_raw_response.get( - network="eth", + network="network", ) assert response.is_closed is True @@ -175,7 +175,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.dexes.with_streaming_response.get( - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -197,8 +197,8 @@ async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_pools(self, async_client: AsyncCoingecko) -> None: dex = await async_client.onchain.networks.dexes.get_pools( - dex="sushiswap", - network="eth", + dex="dex", + network="network", ) assert_matches_type(DexGetPoolsResponse, dex, path=["response"]) @@ -206,8 +206,8 @@ async def test_method_get_pools(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_pools_with_all_params(self, async_client: AsyncCoingecko) -> None: dex = await async_client.onchain.networks.dexes.get_pools( - dex="sushiswap", - network="eth", + dex="dex", + network="network", include="include", include_gt_community_data=True, page=0, @@ -219,8 +219,8 @@ async def test_method_get_pools_with_all_params(self, async_client: AsyncCoingec @parametrize async def test_raw_response_get_pools(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.dexes.with_raw_response.get_pools( - dex="sushiswap", - network="eth", + dex="dex", + network="network", ) assert response.is_closed is True @@ -232,8 +232,8 @@ async def test_raw_response_get_pools(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_streaming_response_get_pools(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.dexes.with_streaming_response.get_pools( - dex="sushiswap", - network="eth", + dex="dex", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -248,12 +248,12 @@ async def test_streaming_response_get_pools(self, async_client: AsyncCoingecko) async def test_path_params_get_pools(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.dexes.with_raw_response.get_pools( - dex="sushiswap", + dex="dex", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `dex` but received ''"): await async_client.onchain.networks.dexes.with_raw_response.get_pools( dex="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/networks/test_new_pools.py b/tests/api_resources/onchain/networks/test_new_pools.py index 561f9c5..dd5c613 100644 --- a/tests/api_resources/onchain/networks/test_new_pools.py +++ b/tests/api_resources/onchain/networks/test_new_pools.py @@ -62,7 +62,7 @@ def test_streaming_response_get(self, client: Coingecko) -> None: @parametrize def test_method_get_network(self, client: Coingecko) -> None: new_pool = client.onchain.networks.new_pools.get_network( - network="eth", + network="network", ) assert_matches_type(NewPoolGetNetworkResponse, new_pool, path=["response"]) @@ -70,7 +70,7 @@ def test_method_get_network(self, client: Coingecko) -> None: @parametrize def test_method_get_network_with_all_params(self, client: Coingecko) -> None: new_pool = client.onchain.networks.new_pools.get_network( - network="eth", + network="network", include="include", include_gt_community_data=True, page=0, @@ -81,7 +81,7 @@ def test_method_get_network_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_network(self, client: Coingecko) -> None: response = client.onchain.networks.new_pools.with_raw_response.get_network( - network="eth", + network="network", ) assert response.is_closed is True @@ -93,7 +93,7 @@ def test_raw_response_get_network(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_network(self, client: Coingecko) -> None: with client.onchain.networks.new_pools.with_streaming_response.get_network( - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -159,7 +159,7 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_method_get_network(self, async_client: AsyncCoingecko) -> None: new_pool = await async_client.onchain.networks.new_pools.get_network( - network="eth", + network="network", ) assert_matches_type(NewPoolGetNetworkResponse, new_pool, path=["response"]) @@ -167,7 +167,7 @@ async def test_method_get_network(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_network_with_all_params(self, async_client: AsyncCoingecko) -> None: new_pool = await async_client.onchain.networks.new_pools.get_network( - network="eth", + network="network", include="include", include_gt_community_data=True, page=0, @@ -178,7 +178,7 @@ async def test_method_get_network_with_all_params(self, async_client: AsyncCoing @parametrize async def test_raw_response_get_network(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.new_pools.with_raw_response.get_network( - network="eth", + network="network", ) assert response.is_closed is True @@ -190,7 +190,7 @@ async def test_raw_response_get_network(self, async_client: AsyncCoingecko) -> N @parametrize async def test_streaming_response_get_network(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.new_pools.with_streaming_response.get_network( - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/onchain/networks/test_pools.py b/tests/api_resources/onchain/networks/test_pools.py index ae7b137..fe8d041 100644 --- a/tests/api_resources/onchain/networks/test_pools.py +++ b/tests/api_resources/onchain/networks/test_pools.py @@ -24,7 +24,7 @@ class TestPools: @parametrize def test_method_get(self, client: Coingecko) -> None: pool = client.onchain.networks.pools.get( - network="eth", + network="network", ) assert_matches_type(PoolGetResponse, pool, path=["response"]) @@ -32,7 +32,7 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: pool = client.onchain.networks.pools.get( - network="eth", + network="network", include="include", include_gt_community_data=True, page=0, @@ -44,7 +44,7 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.pools.with_raw_response.get( - network="eth", + network="network", ) assert response.is_closed is True @@ -56,7 +56,7 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.pools.with_streaming_response.get( - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -78,8 +78,8 @@ def test_path_params_get(self, client: Coingecko) -> None: @parametrize def test_method_get_address(self, client: Coingecko) -> None: pool = client.onchain.networks.pools.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", - network="eth", + address="address", + network="network", ) assert_matches_type(PoolGetAddressResponse, pool, path=["response"]) @@ -87,8 +87,8 @@ def test_method_get_address(self, client: Coingecko) -> None: @parametrize def test_method_get_address_with_all_params(self, client: Coingecko) -> None: pool = client.onchain.networks.pools.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", - network="eth", + address="address", + network="network", include="include", include_composition=True, include_volume_breakdown=True, @@ -99,8 +99,8 @@ def test_method_get_address_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_address(self, client: Coingecko) -> None: response = client.onchain.networks.pools.with_raw_response.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", - network="eth", + address="address", + network="network", ) assert response.is_closed is True @@ -112,8 +112,8 @@ def test_raw_response_get_address(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_address(self, client: Coingecko) -> None: with client.onchain.networks.pools.with_streaming_response.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", - network="eth", + address="address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -128,14 +128,14 @@ def test_streaming_response_get_address(self, client: Coingecko) -> None: def test_path_params_get_address(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.pools.with_raw_response.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", + address="address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `address` but received ''"): client.onchain.networks.pools.with_raw_response.get_address( address="", - network="eth", + network="network", ) @@ -148,7 +148,7 @@ class TestAsyncPools: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: pool = await async_client.onchain.networks.pools.get( - network="eth", + network="network", ) assert_matches_type(PoolGetResponse, pool, path=["response"]) @@ -156,7 +156,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: pool = await async_client.onchain.networks.pools.get( - network="eth", + network="network", include="include", include_gt_community_data=True, page=0, @@ -168,7 +168,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.pools.with_raw_response.get( - network="eth", + network="network", ) assert response.is_closed is True @@ -180,7 +180,7 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.pools.with_streaming_response.get( - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -202,8 +202,8 @@ async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_address(self, async_client: AsyncCoingecko) -> None: pool = await async_client.onchain.networks.pools.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", - network="eth", + address="address", + network="network", ) assert_matches_type(PoolGetAddressResponse, pool, path=["response"]) @@ -211,8 +211,8 @@ async def test_method_get_address(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_address_with_all_params(self, async_client: AsyncCoingecko) -> None: pool = await async_client.onchain.networks.pools.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", - network="eth", + address="address", + network="network", include="include", include_composition=True, include_volume_breakdown=True, @@ -223,8 +223,8 @@ async def test_method_get_address_with_all_params(self, async_client: AsyncCoing @parametrize async def test_raw_response_get_address(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.pools.with_raw_response.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", - network="eth", + address="address", + network="network", ) assert response.is_closed is True @@ -236,8 +236,8 @@ async def test_raw_response_get_address(self, async_client: AsyncCoingecko) -> N @parametrize async def test_streaming_response_get_address(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.pools.with_streaming_response.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", - network="eth", + address="address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -252,12 +252,12 @@ async def test_streaming_response_get_address(self, async_client: AsyncCoingecko async def test_path_params_get_address(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.pools.with_raw_response.get_address( - address="0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", + address="address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `address` but received ''"): await async_client.onchain.networks.pools.with_raw_response.get_address( address="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/networks/test_tokens.py b/tests/api_resources/onchain/networks/test_tokens.py index 8b2f5cb..c050a45 100644 --- a/tests/api_resources/onchain/networks/test_tokens.py +++ b/tests/api_resources/onchain/networks/test_tokens.py @@ -21,8 +21,8 @@ class TestTokens: @parametrize def test_method_get_address(self, client: Coingecko) -> None: token = client.onchain.networks.tokens.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) assert_matches_type(TokenGetAddressResponse, token, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get_address(self, client: Coingecko) -> None: @parametrize def test_method_get_address_with_all_params(self, client: Coingecko) -> None: token = client.onchain.networks.tokens.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", include="top_pools", include_composition=True, include_inactive_source=True, @@ -42,8 +42,8 @@ def test_method_get_address_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_address(self, client: Coingecko) -> None: response = client.onchain.networks.tokens.with_raw_response.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) assert response.is_closed is True @@ -55,8 +55,8 @@ def test_raw_response_get_address(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_address(self, client: Coingecko) -> None: with client.onchain.networks.tokens.with_streaming_response.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -71,14 +71,14 @@ def test_streaming_response_get_address(self, client: Coingecko) -> None: def test_path_params_get_address(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.tokens.with_raw_response.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", + address="address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `address` but received ''"): client.onchain.networks.tokens.with_raw_response.get_address( address="", - network="eth", + network="network", ) @@ -91,8 +91,8 @@ class TestAsyncTokens: @parametrize async def test_method_get_address(self, async_client: AsyncCoingecko) -> None: token = await async_client.onchain.networks.tokens.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) assert_matches_type(TokenGetAddressResponse, token, path=["response"]) @@ -100,8 +100,8 @@ async def test_method_get_address(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_address_with_all_params(self, async_client: AsyncCoingecko) -> None: token = await async_client.onchain.networks.tokens.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", include="top_pools", include_composition=True, include_inactive_source=True, @@ -112,8 +112,8 @@ async def test_method_get_address_with_all_params(self, async_client: AsyncCoing @parametrize async def test_raw_response_get_address(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.tokens.with_raw_response.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) assert response.is_closed is True @@ -125,8 +125,8 @@ async def test_raw_response_get_address(self, async_client: AsyncCoingecko) -> N @parametrize async def test_streaming_response_get_address(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.tokens.with_streaming_response.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -141,12 +141,12 @@ async def test_streaming_response_get_address(self, async_client: AsyncCoingecko async def test_path_params_get_address(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.tokens.with_raw_response.get_address( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", + address="address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `address` but received ''"): await async_client.onchain.networks.tokens.with_raw_response.get_address( address="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/networks/test_trending_pools.py b/tests/api_resources/onchain/networks/test_trending_pools.py index 4174ccb..42cd489 100644 --- a/tests/api_resources/onchain/networks/test_trending_pools.py +++ b/tests/api_resources/onchain/networks/test_trending_pools.py @@ -63,7 +63,7 @@ def test_streaming_response_get(self, client: Coingecko) -> None: @parametrize def test_method_get_network(self, client: Coingecko) -> None: trending_pool = client.onchain.networks.trending_pools.get_network( - network="eth", + network="network", ) assert_matches_type(TrendingPoolGetNetworkResponse, trending_pool, path=["response"]) @@ -71,7 +71,7 @@ def test_method_get_network(self, client: Coingecko) -> None: @parametrize def test_method_get_network_with_all_params(self, client: Coingecko) -> None: trending_pool = client.onchain.networks.trending_pools.get_network( - network="eth", + network="network", duration="5m", include="include", include_gt_community_data=True, @@ -83,7 +83,7 @@ def test_method_get_network_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_network(self, client: Coingecko) -> None: response = client.onchain.networks.trending_pools.with_raw_response.get_network( - network="eth", + network="network", ) assert response.is_closed is True @@ -95,7 +95,7 @@ def test_raw_response_get_network(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_network(self, client: Coingecko) -> None: with client.onchain.networks.trending_pools.with_streaming_response.get_network( - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -162,7 +162,7 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_method_get_network(self, async_client: AsyncCoingecko) -> None: trending_pool = await async_client.onchain.networks.trending_pools.get_network( - network="eth", + network="network", ) assert_matches_type(TrendingPoolGetNetworkResponse, trending_pool, path=["response"]) @@ -170,7 +170,7 @@ async def test_method_get_network(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_network_with_all_params(self, async_client: AsyncCoingecko) -> None: trending_pool = await async_client.onchain.networks.trending_pools.get_network( - network="eth", + network="network", duration="5m", include="include", include_gt_community_data=True, @@ -182,7 +182,7 @@ async def test_method_get_network_with_all_params(self, async_client: AsyncCoing @parametrize async def test_raw_response_get_network(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.trending_pools.with_raw_response.get_network( - network="eth", + network="network", ) assert response.is_closed is True @@ -194,7 +194,7 @@ async def test_raw_response_get_network(self, async_client: AsyncCoingecko) -> N @parametrize async def test_streaming_response_get_network(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.trending_pools.with_streaming_response.get_network( - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/onchain/networks/tokens/test_holders_chart.py b/tests/api_resources/onchain/networks/tokens/test_holders_chart.py index 797b1d6..f1a040f 100644 --- a/tests/api_resources/onchain/networks/tokens/test_holders_chart.py +++ b/tests/api_resources/onchain/networks/tokens/test_holders_chart.py @@ -21,8 +21,8 @@ class TestHoldersChart: @parametrize def test_method_get(self, client: Coingecko) -> None: holders_chart = client.onchain.networks.tokens.holders_chart.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert_matches_type(HoldersChartGetResponse, holders_chart, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: holders_chart = client.onchain.networks.tokens.holders_chart.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", days="7", ) assert_matches_type(HoldersChartGetResponse, holders_chart, path=["response"]) @@ -40,8 +40,8 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.tokens.holders_chart.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert response.is_closed is True @@ -53,8 +53,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.tokens.holders_chart.with_streaming_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -69,14 +69,14 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.tokens.holders_chart.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", + token_address="token_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): client.onchain.networks.tokens.holders_chart.with_raw_response.get( token_address="", - network="eth", + network="network", ) @@ -89,8 +89,8 @@ class TestAsyncHoldersChart: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: holders_chart = await async_client.onchain.networks.tokens.holders_chart.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert_matches_type(HoldersChartGetResponse, holders_chart, path=["response"]) @@ -98,8 +98,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: holders_chart = await async_client.onchain.networks.tokens.holders_chart.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", days="7", ) assert_matches_type(HoldersChartGetResponse, holders_chart, path=["response"]) @@ -108,8 +108,8 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.tokens.holders_chart.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert response.is_closed is True @@ -121,8 +121,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.tokens.holders_chart.with_streaming_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -137,12 +137,12 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.tokens.holders_chart.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", + token_address="token_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): await async_client.onchain.networks.tokens.holders_chart.with_raw_response.get( token_address="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/networks/tokens/test_info.py b/tests/api_resources/onchain/networks/tokens/test_info.py index bd9f7b5..6b89e4b 100644 --- a/tests/api_resources/onchain/networks/tokens/test_info.py +++ b/tests/api_resources/onchain/networks/tokens/test_info.py @@ -21,8 +21,8 @@ class TestInfo: @parametrize def test_method_get(self, client: Coingecko) -> None: info = client.onchain.networks.tokens.info.get( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) assert_matches_type(InfoGetResponse, info, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.tokens.info.with_raw_response.get( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) assert response.is_closed is True @@ -43,8 +43,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.tokens.info.with_streaming_response.get( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -59,14 +59,14 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.tokens.info.with_raw_response.get( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", + address="address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `address` but received ''"): client.onchain.networks.tokens.info.with_raw_response.get( address="", - network="eth", + network="network", ) @@ -79,8 +79,8 @@ class TestAsyncInfo: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: info = await async_client.onchain.networks.tokens.info.get( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) assert_matches_type(InfoGetResponse, info, path=["response"]) @@ -88,8 +88,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.tokens.info.with_raw_response.get( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) assert response.is_closed is True @@ -101,8 +101,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.tokens.info.with_streaming_response.get( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + address="address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -117,12 +117,12 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.tokens.info.with_raw_response.get( - address="0xdac17f958d2ee523a2206206994597c13d831ec7", + address="address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `address` but received ''"): await async_client.onchain.networks.tokens.info.with_raw_response.get( address="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/networks/tokens/test_multi.py b/tests/api_resources/onchain/networks/tokens/test_multi.py index c2637f8..c48fef9 100644 --- a/tests/api_resources/onchain/networks/tokens/test_multi.py +++ b/tests/api_resources/onchain/networks/tokens/test_multi.py @@ -22,7 +22,7 @@ class TestMulti: def test_method_get_addresses(self, client: Coingecko) -> None: multi = client.onchain.networks.tokens.multi.get_addresses( addresses="addresses", - network="solana", + network="network", ) assert_matches_type(MultiGetAddressesResponse, multi, path=["response"]) @@ -31,7 +31,7 @@ def test_method_get_addresses(self, client: Coingecko) -> None: def test_method_get_addresses_with_all_params(self, client: Coingecko) -> None: multi = client.onchain.networks.tokens.multi.get_addresses( addresses="addresses", - network="solana", + network="network", include="top_pools", include_composition=True, include_inactive_source=True, @@ -43,7 +43,7 @@ def test_method_get_addresses_with_all_params(self, client: Coingecko) -> None: def test_raw_response_get_addresses(self, client: Coingecko) -> None: response = client.onchain.networks.tokens.multi.with_raw_response.get_addresses( addresses="addresses", - network="solana", + network="network", ) assert response.is_closed is True @@ -56,7 +56,7 @@ def test_raw_response_get_addresses(self, client: Coingecko) -> None: def test_streaming_response_get_addresses(self, client: Coingecko) -> None: with client.onchain.networks.tokens.multi.with_streaming_response.get_addresses( addresses="addresses", - network="solana", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -78,7 +78,7 @@ def test_path_params_get_addresses(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `addresses` but received ''"): client.onchain.networks.tokens.multi.with_raw_response.get_addresses( addresses="", - network="solana", + network="network", ) @@ -92,7 +92,7 @@ class TestAsyncMulti: async def test_method_get_addresses(self, async_client: AsyncCoingecko) -> None: multi = await async_client.onchain.networks.tokens.multi.get_addresses( addresses="addresses", - network="solana", + network="network", ) assert_matches_type(MultiGetAddressesResponse, multi, path=["response"]) @@ -101,7 +101,7 @@ async def test_method_get_addresses(self, async_client: AsyncCoingecko) -> None: async def test_method_get_addresses_with_all_params(self, async_client: AsyncCoingecko) -> None: multi = await async_client.onchain.networks.tokens.multi.get_addresses( addresses="addresses", - network="solana", + network="network", include="top_pools", include_composition=True, include_inactive_source=True, @@ -113,7 +113,7 @@ async def test_method_get_addresses_with_all_params(self, async_client: AsyncCoi async def test_raw_response_get_addresses(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.tokens.multi.with_raw_response.get_addresses( addresses="addresses", - network="solana", + network="network", ) assert response.is_closed is True @@ -126,7 +126,7 @@ async def test_raw_response_get_addresses(self, async_client: AsyncCoingecko) -> async def test_streaming_response_get_addresses(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.tokens.multi.with_streaming_response.get_addresses( addresses="addresses", - network="solana", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -148,5 +148,5 @@ async def test_path_params_get_addresses(self, async_client: AsyncCoingecko) -> with pytest.raises(ValueError, match=r"Expected a non-empty value for `addresses` but received ''"): await async_client.onchain.networks.tokens.multi.with_raw_response.get_addresses( addresses="", - network="solana", + network="network", ) diff --git a/tests/api_resources/onchain/networks/tokens/test_ohlcv.py b/tests/api_resources/onchain/networks/tokens/test_ohlcv.py index 8483280..8beab16 100644 --- a/tests/api_resources/onchain/networks/tokens/test_ohlcv.py +++ b/tests/api_resources/onchain/networks/tokens/test_ohlcv.py @@ -22,8 +22,8 @@ class TestOhlcv: def test_method_get_timeframe(self, client: Coingecko) -> None: ohlcv = client.onchain.networks.tokens.ohlcv.get_timeframe( timeframe="day", - network="solana", - token_address="So11111111111111111111111111111111111111112", + network="network", + token_address="token_address", ) assert_matches_type(OhlcvGetTimeframeResponse, ohlcv, path=["response"]) @@ -32,8 +32,8 @@ def test_method_get_timeframe(self, client: Coingecko) -> None: def test_method_get_timeframe_with_all_params(self, client: Coingecko) -> None: ohlcv = client.onchain.networks.tokens.ohlcv.get_timeframe( timeframe="day", - network="solana", - token_address="So11111111111111111111111111111111111111112", + network="network", + token_address="token_address", aggregate="aggregate", before_timestamp=0, currency="usd", @@ -48,8 +48,8 @@ def test_method_get_timeframe_with_all_params(self, client: Coingecko) -> None: def test_raw_response_get_timeframe(self, client: Coingecko) -> None: response = client.onchain.networks.tokens.ohlcv.with_raw_response.get_timeframe( timeframe="day", - network="solana", - token_address="So11111111111111111111111111111111111111112", + network="network", + token_address="token_address", ) assert response.is_closed is True @@ -62,8 +62,8 @@ def test_raw_response_get_timeframe(self, client: Coingecko) -> None: def test_streaming_response_get_timeframe(self, client: Coingecko) -> None: with client.onchain.networks.tokens.ohlcv.with_streaming_response.get_timeframe( timeframe="day", - network="solana", - token_address="So11111111111111111111111111111111111111112", + network="network", + token_address="token_address", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -80,13 +80,13 @@ def test_path_params_get_timeframe(self, client: Coingecko) -> None: client.onchain.networks.tokens.ohlcv.with_raw_response.get_timeframe( timeframe="day", network="", - token_address="So11111111111111111111111111111111111111112", + token_address="token_address", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): client.onchain.networks.tokens.ohlcv.with_raw_response.get_timeframe( timeframe="day", - network="solana", + network="network", token_address="", ) @@ -101,8 +101,8 @@ class TestAsyncOhlcv: async def test_method_get_timeframe(self, async_client: AsyncCoingecko) -> None: ohlcv = await async_client.onchain.networks.tokens.ohlcv.get_timeframe( timeframe="day", - network="solana", - token_address="So11111111111111111111111111111111111111112", + network="network", + token_address="token_address", ) assert_matches_type(OhlcvGetTimeframeResponse, ohlcv, path=["response"]) @@ -111,8 +111,8 @@ async def test_method_get_timeframe(self, async_client: AsyncCoingecko) -> None: async def test_method_get_timeframe_with_all_params(self, async_client: AsyncCoingecko) -> None: ohlcv = await async_client.onchain.networks.tokens.ohlcv.get_timeframe( timeframe="day", - network="solana", - token_address="So11111111111111111111111111111111111111112", + network="network", + token_address="token_address", aggregate="aggregate", before_timestamp=0, currency="usd", @@ -127,8 +127,8 @@ async def test_method_get_timeframe_with_all_params(self, async_client: AsyncCoi async def test_raw_response_get_timeframe(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.tokens.ohlcv.with_raw_response.get_timeframe( timeframe="day", - network="solana", - token_address="So11111111111111111111111111111111111111112", + network="network", + token_address="token_address", ) assert response.is_closed is True @@ -141,8 +141,8 @@ async def test_raw_response_get_timeframe(self, async_client: AsyncCoingecko) -> async def test_streaming_response_get_timeframe(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.tokens.ohlcv.with_streaming_response.get_timeframe( timeframe="day", - network="solana", - token_address="So11111111111111111111111111111111111111112", + network="network", + token_address="token_address", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -159,12 +159,12 @@ async def test_path_params_get_timeframe(self, async_client: AsyncCoingecko) -> await async_client.onchain.networks.tokens.ohlcv.with_raw_response.get_timeframe( timeframe="day", network="", - token_address="So11111111111111111111111111111111111111112", + token_address="token_address", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): await async_client.onchain.networks.tokens.ohlcv.with_raw_response.get_timeframe( timeframe="day", - network="solana", + network="network", token_address="", ) diff --git a/tests/api_resources/onchain/networks/tokens/test_pools.py b/tests/api_resources/onchain/networks/tokens/test_pools.py index 3674593..2aedf62 100644 --- a/tests/api_resources/onchain/networks/tokens/test_pools.py +++ b/tests/api_resources/onchain/networks/tokens/test_pools.py @@ -21,8 +21,8 @@ class TestPools: @parametrize def test_method_get(self, client: Coingecko) -> None: pool = client.onchain.networks.tokens.pools.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert_matches_type(PoolGetResponse, pool, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: pool = client.onchain.networks.tokens.pools.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", include="include", include_gt_community_data=True, include_inactive_source=True, @@ -44,8 +44,8 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.tokens.pools.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert response.is_closed is True @@ -57,8 +57,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.tokens.pools.with_streaming_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -73,14 +73,14 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.tokens.pools.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", + token_address="token_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): client.onchain.networks.tokens.pools.with_raw_response.get( token_address="", - network="eth", + network="network", ) @@ -93,8 +93,8 @@ class TestAsyncPools: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: pool = await async_client.onchain.networks.tokens.pools.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert_matches_type(PoolGetResponse, pool, path=["response"]) @@ -102,8 +102,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: pool = await async_client.onchain.networks.tokens.pools.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", include="include", include_gt_community_data=True, include_inactive_source=True, @@ -116,8 +116,8 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.tokens.pools.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert response.is_closed is True @@ -129,8 +129,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.tokens.pools.with_streaming_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -145,12 +145,12 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.tokens.pools.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", + token_address="token_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): await async_client.onchain.networks.tokens.pools.with_raw_response.get( token_address="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/networks/tokens/test_top_holders.py b/tests/api_resources/onchain/networks/tokens/test_top_holders.py index 96f0e35..3b90b4f 100644 --- a/tests/api_resources/onchain/networks/tokens/test_top_holders.py +++ b/tests/api_resources/onchain/networks/tokens/test_top_holders.py @@ -21,8 +21,8 @@ class TestTopHolders: @parametrize def test_method_get(self, client: Coingecko) -> None: top_holder = client.onchain.networks.tokens.top_holders.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network="base", + address="address", + network="network", ) assert_matches_type(TopHolderGetResponse, top_holder, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: top_holder = client.onchain.networks.tokens.top_holders.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network="base", + address="address", + network="network", holders="holders", include_pnl_details=True, ) @@ -41,8 +41,8 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.tokens.top_holders.with_raw_response.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network="base", + address="address", + network="network", ) assert response.is_closed is True @@ -54,8 +54,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.tokens.top_holders.with_streaming_response.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network="base", + address="address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -70,14 +70,14 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.tokens.top_holders.with_raw_response.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", + address="address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `address` but received ''"): client.onchain.networks.tokens.top_holders.with_raw_response.get( address="", - network="base", + network="network", ) @@ -90,8 +90,8 @@ class TestAsyncTopHolders: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: top_holder = await async_client.onchain.networks.tokens.top_holders.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network="base", + address="address", + network="network", ) assert_matches_type(TopHolderGetResponse, top_holder, path=["response"]) @@ -99,8 +99,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: top_holder = await async_client.onchain.networks.tokens.top_holders.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network="base", + address="address", + network="network", holders="holders", include_pnl_details=True, ) @@ -110,8 +110,8 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.tokens.top_holders.with_raw_response.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network="base", + address="address", + network="network", ) assert response.is_closed is True @@ -123,8 +123,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.tokens.top_holders.with_streaming_response.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network="base", + address="address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -139,12 +139,12 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.tokens.top_holders.with_raw_response.get( - address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", + address="address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `address` but received ''"): await async_client.onchain.networks.tokens.top_holders.with_raw_response.get( address="", - network="base", + network="network", ) diff --git a/tests/api_resources/onchain/networks/tokens/test_top_traders.py b/tests/api_resources/onchain/networks/tokens/test_top_traders.py index f891cd5..40638ac 100644 --- a/tests/api_resources/onchain/networks/tokens/test_top_traders.py +++ b/tests/api_resources/onchain/networks/tokens/test_top_traders.py @@ -21,8 +21,8 @@ class TestTopTraders: @parametrize def test_method_get(self, client: Coingecko) -> None: top_trader = client.onchain.networks.tokens.top_traders.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network_id="base", + token_address="token_address", + network_id="network_id", ) assert_matches_type(TopTraderGetResponse, top_trader, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: top_trader = client.onchain.networks.tokens.top_traders.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network_id="base", + token_address="token_address", + network_id="network_id", include_address_label=True, sort="realized_pnl_usd_desc", traders="traders", @@ -42,8 +42,8 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.tokens.top_traders.with_raw_response.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network_id="base", + token_address="token_address", + network_id="network_id", ) assert response.is_closed is True @@ -55,8 +55,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.tokens.top_traders.with_streaming_response.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network_id="base", + token_address="token_address", + network_id="network_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -71,14 +71,14 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network_id` but received ''"): client.onchain.networks.tokens.top_traders.with_raw_response.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", + token_address="token_address", network_id="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): client.onchain.networks.tokens.top_traders.with_raw_response.get( token_address="", - network_id="base", + network_id="network_id", ) @@ -91,8 +91,8 @@ class TestAsyncTopTraders: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: top_trader = await async_client.onchain.networks.tokens.top_traders.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network_id="base", + token_address="token_address", + network_id="network_id", ) assert_matches_type(TopTraderGetResponse, top_trader, path=["response"]) @@ -100,8 +100,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: top_trader = await async_client.onchain.networks.tokens.top_traders.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network_id="base", + token_address="token_address", + network_id="network_id", include_address_label=True, sort="realized_pnl_usd_desc", traders="traders", @@ -112,8 +112,8 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.tokens.top_traders.with_raw_response.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network_id="base", + token_address="token_address", + network_id="network_id", ) assert response.is_closed is True @@ -125,8 +125,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.tokens.top_traders.with_streaming_response.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", - network_id="base", + token_address="token_address", + network_id="network_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -141,12 +141,12 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network_id` but received ''"): await async_client.onchain.networks.tokens.top_traders.with_raw_response.get( - token_address="0x6921b130d297cc43754afba22e5eac0fbf8db75b", + token_address="token_address", network_id="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): await async_client.onchain.networks.tokens.top_traders.with_raw_response.get( token_address="", - network_id="base", + network_id="network_id", ) diff --git a/tests/api_resources/onchain/networks/tokens/test_trades.py b/tests/api_resources/onchain/networks/tokens/test_trades.py index 0177c4e..590b918 100644 --- a/tests/api_resources/onchain/networks/tokens/test_trades.py +++ b/tests/api_resources/onchain/networks/tokens/test_trades.py @@ -21,8 +21,8 @@ class TestTrades: @parametrize def test_method_get(self, client: Coingecko) -> None: trade = client.onchain.networks.tokens.trades.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert_matches_type(TradeGetResponse, trade, path=["response"]) @@ -30,8 +30,8 @@ def test_method_get(self, client: Coingecko) -> None: @parametrize def test_method_get_with_all_params(self, client: Coingecko) -> None: trade = client.onchain.networks.tokens.trades.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", trade_volume_in_usd_greater_than=0, ) assert_matches_type(TradeGetResponse, trade, path=["response"]) @@ -40,8 +40,8 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get(self, client: Coingecko) -> None: response = client.onchain.networks.tokens.trades.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert response.is_closed is True @@ -53,8 +53,8 @@ def test_raw_response_get(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get(self, client: Coingecko) -> None: with client.onchain.networks.tokens.trades.with_streaming_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -69,14 +69,14 @@ def test_streaming_response_get(self, client: Coingecko) -> None: def test_path_params_get(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): client.onchain.networks.tokens.trades.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", + token_address="token_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): client.onchain.networks.tokens.trades.with_raw_response.get( token_address="", - network="eth", + network="network", ) @@ -89,8 +89,8 @@ class TestAsyncTrades: @parametrize async def test_method_get(self, async_client: AsyncCoingecko) -> None: trade = await async_client.onchain.networks.tokens.trades.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert_matches_type(TradeGetResponse, trade, path=["response"]) @@ -98,8 +98,8 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: trade = await async_client.onchain.networks.tokens.trades.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", trade_volume_in_usd_greater_than=0, ) assert_matches_type(TradeGetResponse, trade, path=["response"]) @@ -108,8 +108,8 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> @parametrize async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.networks.tokens.trades.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) assert response.is_closed is True @@ -121,8 +121,8 @@ async def test_raw_response_get(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.networks.tokens.trades.with_streaming_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", - network="eth", + token_address="token_address", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -137,12 +137,12 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non async def test_path_params_get(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `network` but received ''"): await async_client.onchain.networks.tokens.trades.with_raw_response.get( - token_address="0xdac17f958d2ee523a2206206994597c13d831ec7", + token_address="token_address", network="", ) with pytest.raises(ValueError, match=r"Expected a non-empty value for `token_address` but received ''"): await async_client.onchain.networks.tokens.trades.with_raw_response.get( token_address="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/search/test_pools.py b/tests/api_resources/onchain/search/test_pools.py index e960d12..5a4903b 100644 --- a/tests/api_resources/onchain/search/test_pools.py +++ b/tests/api_resources/onchain/search/test_pools.py @@ -28,9 +28,9 @@ def test_method_get(self, client: Coingecko) -> None: def test_method_get_with_all_params(self, client: Coingecko) -> None: pool = client.onchain.search.pools.get( include="include", - network="eth", + network="network", page=0, - query="weth", + query="query", ) assert_matches_type(PoolGetResponse, pool, path=["response"]) @@ -73,9 +73,9 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: pool = await async_client.onchain.search.pools.get( include="include", - network="eth", + network="network", page=0, - query="weth", + query="query", ) assert_matches_type(PoolGetResponse, pool, path=["response"]) diff --git a/tests/api_resources/onchain/simple/networks/test_token_price.py b/tests/api_resources/onchain/simple/networks/test_token_price.py index 943fa31..8c0f548 100644 --- a/tests/api_resources/onchain/simple/networks/test_token_price.py +++ b/tests/api_resources/onchain/simple/networks/test_token_price.py @@ -22,7 +22,7 @@ class TestTokenPrice: def test_method_get_addresses(self, client: Coingecko) -> None: token_price = client.onchain.simple.networks.token_price.get_addresses( addresses="addresses", - network="eth", + network="network", ) assert_matches_type(TokenPriceGetAddressesResponse, token_price, path=["response"]) @@ -31,7 +31,7 @@ def test_method_get_addresses(self, client: Coingecko) -> None: def test_method_get_addresses_with_all_params(self, client: Coingecko) -> None: token_price = client.onchain.simple.networks.token_price.get_addresses( addresses="addresses", - network="eth", + network="network", include_24hr_price_change=True, include_24hr_vol=True, include_inactive_source=True, @@ -46,7 +46,7 @@ def test_method_get_addresses_with_all_params(self, client: Coingecko) -> None: def test_raw_response_get_addresses(self, client: Coingecko) -> None: response = client.onchain.simple.networks.token_price.with_raw_response.get_addresses( addresses="addresses", - network="eth", + network="network", ) assert response.is_closed is True @@ -59,7 +59,7 @@ def test_raw_response_get_addresses(self, client: Coingecko) -> None: def test_streaming_response_get_addresses(self, client: Coingecko) -> None: with client.onchain.simple.networks.token_price.with_streaming_response.get_addresses( addresses="addresses", - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -81,7 +81,7 @@ def test_path_params_get_addresses(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `addresses` but received ''"): client.onchain.simple.networks.token_price.with_raw_response.get_addresses( addresses="", - network="eth", + network="network", ) @@ -95,7 +95,7 @@ class TestAsyncTokenPrice: async def test_method_get_addresses(self, async_client: AsyncCoingecko) -> None: token_price = await async_client.onchain.simple.networks.token_price.get_addresses( addresses="addresses", - network="eth", + network="network", ) assert_matches_type(TokenPriceGetAddressesResponse, token_price, path=["response"]) @@ -104,7 +104,7 @@ async def test_method_get_addresses(self, async_client: AsyncCoingecko) -> None: async def test_method_get_addresses_with_all_params(self, async_client: AsyncCoingecko) -> None: token_price = await async_client.onchain.simple.networks.token_price.get_addresses( addresses="addresses", - network="eth", + network="network", include_24hr_price_change=True, include_24hr_vol=True, include_inactive_source=True, @@ -119,7 +119,7 @@ async def test_method_get_addresses_with_all_params(self, async_client: AsyncCoi async def test_raw_response_get_addresses(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.simple.networks.token_price.with_raw_response.get_addresses( addresses="addresses", - network="eth", + network="network", ) assert response.is_closed is True @@ -132,7 +132,7 @@ async def test_raw_response_get_addresses(self, async_client: AsyncCoingecko) -> async def test_streaming_response_get_addresses(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.simple.networks.token_price.with_streaming_response.get_addresses( addresses="addresses", - network="eth", + network="network", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -154,5 +154,5 @@ async def test_path_params_get_addresses(self, async_client: AsyncCoingecko) -> with pytest.raises(ValueError, match=r"Expected a non-empty value for `addresses` but received ''"): await async_client.onchain.simple.networks.token_price.with_raw_response.get_addresses( addresses="", - network="eth", + network="network", ) diff --git a/tests/api_resources/onchain/test_categories.py b/tests/api_resources/onchain/test_categories.py index 5082825..502be80 100644 --- a/tests/api_resources/onchain/test_categories.py +++ b/tests/api_resources/onchain/test_categories.py @@ -61,7 +61,7 @@ def test_streaming_response_get(self, client: Coingecko) -> None: @parametrize def test_method_get_pools(self, client: Coingecko) -> None: category = client.onchain.categories.get_pools( - category_id="pump-fun", + category_id="category_id", ) assert_matches_type(CategoryGetPoolsResponse, category, path=["response"]) @@ -69,7 +69,7 @@ def test_method_get_pools(self, client: Coingecko) -> None: @parametrize def test_method_get_pools_with_all_params(self, client: Coingecko) -> None: category = client.onchain.categories.get_pools( - category_id="pump-fun", + category_id="category_id", include="include", page=0, sort="m5_trending", @@ -80,7 +80,7 @@ def test_method_get_pools_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_pools(self, client: Coingecko) -> None: response = client.onchain.categories.with_raw_response.get_pools( - category_id="pump-fun", + category_id="category_id", ) assert response.is_closed is True @@ -92,7 +92,7 @@ def test_raw_response_get_pools(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_pools(self, client: Coingecko) -> None: with client.onchain.categories.with_streaming_response.get_pools( - category_id="pump-fun", + category_id="category_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -157,7 +157,7 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_method_get_pools(self, async_client: AsyncCoingecko) -> None: category = await async_client.onchain.categories.get_pools( - category_id="pump-fun", + category_id="category_id", ) assert_matches_type(CategoryGetPoolsResponse, category, path=["response"]) @@ -165,7 +165,7 @@ async def test_method_get_pools(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_pools_with_all_params(self, async_client: AsyncCoingecko) -> None: category = await async_client.onchain.categories.get_pools( - category_id="pump-fun", + category_id="category_id", include="include", page=0, sort="m5_trending", @@ -176,7 +176,7 @@ async def test_method_get_pools_with_all_params(self, async_client: AsyncCoingec @parametrize async def test_raw_response_get_pools(self, async_client: AsyncCoingecko) -> None: response = await async_client.onchain.categories.with_raw_response.get_pools( - category_id="pump-fun", + category_id="category_id", ) assert response.is_closed is True @@ -188,7 +188,7 @@ async def test_raw_response_get_pools(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_streaming_response_get_pools(self, async_client: AsyncCoingecko) -> None: async with async_client.onchain.categories.with_streaming_response.get_pools( - category_id="pump-fun", + category_id="category_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/onchain/tokens/test_info_recently_updated.py b/tests/api_resources/onchain/tokens/test_info_recently_updated.py index af18050..1f6147b 100644 --- a/tests/api_resources/onchain/tokens/test_info_recently_updated.py +++ b/tests/api_resources/onchain/tokens/test_info_recently_updated.py @@ -28,7 +28,7 @@ def test_method_get(self, client: Coingecko) -> None: def test_method_get_with_all_params(self, client: Coingecko) -> None: info_recently_updated = client.onchain.tokens.info_recently_updated.get( include="network", - network="eth", + network="network", ) assert_matches_type(InfoRecentlyUpdatedGetResponse, info_recently_updated, path=["response"]) @@ -71,7 +71,7 @@ async def test_method_get(self, async_client: AsyncCoingecko) -> None: async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> None: info_recently_updated = await async_client.onchain.tokens.info_recently_updated.get( include="network", - network="eth", + network="network", ) assert_matches_type(InfoRecentlyUpdatedGetResponse, info_recently_updated, path=["response"]) diff --git a/tests/api_resources/simple/test_token_price.py b/tests/api_resources/simple/test_token_price.py index 45e610f..bf97597 100644 --- a/tests/api_resources/simple/test_token_price.py +++ b/tests/api_resources/simple/test_token_price.py @@ -21,7 +21,7 @@ class TestTokenPrice: @parametrize def test_method_get_id(self, client: Coingecko) -> None: token_price = client.simple.token_price.get_id( - id="ethereum", + id="id", contract_addresses="contract_addresses", vs_currencies="vs_currencies", ) @@ -31,7 +31,7 @@ def test_method_get_id(self, client: Coingecko) -> None: @parametrize def test_method_get_id_with_all_params(self, client: Coingecko) -> None: token_price = client.simple.token_price.get_id( - id="ethereum", + id="id", contract_addresses="contract_addresses", vs_currencies="vs_currencies", include_24hr_change=True, @@ -46,7 +46,7 @@ def test_method_get_id_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_id(self, client: Coingecko) -> None: response = client.simple.token_price.with_raw_response.get_id( - id="ethereum", + id="id", contract_addresses="contract_addresses", vs_currencies="vs_currencies", ) @@ -60,7 +60,7 @@ def test_raw_response_get_id(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_id(self, client: Coingecko) -> None: with client.simple.token_price.with_streaming_response.get_id( - id="ethereum", + id="id", contract_addresses="contract_addresses", vs_currencies="vs_currencies", ) as response: @@ -92,7 +92,7 @@ class TestAsyncTokenPrice: @parametrize async def test_method_get_id(self, async_client: AsyncCoingecko) -> None: token_price = await async_client.simple.token_price.get_id( - id="ethereum", + id="id", contract_addresses="contract_addresses", vs_currencies="vs_currencies", ) @@ -102,7 +102,7 @@ async def test_method_get_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_id_with_all_params(self, async_client: AsyncCoingecko) -> None: token_price = await async_client.simple.token_price.get_id( - id="ethereum", + id="id", contract_addresses="contract_addresses", vs_currencies="vs_currencies", include_24hr_change=True, @@ -117,7 +117,7 @@ async def test_method_get_id_with_all_params(self, async_client: AsyncCoingecko) @parametrize async def test_raw_response_get_id(self, async_client: AsyncCoingecko) -> None: response = await async_client.simple.token_price.with_raw_response.get_id( - id="ethereum", + id="id", contract_addresses="contract_addresses", vs_currencies="vs_currencies", ) @@ -131,7 +131,7 @@ async def test_raw_response_get_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get_id(self, async_client: AsyncCoingecko) -> None: async with async_client.simple.token_price.with_streaming_response.get_id( - id="ethereum", + id="id", contract_addresses="contract_addresses", vs_currencies="vs_currencies", ) as response: diff --git a/tests/api_resources/test_exchanges.py b/tests/api_resources/test_exchanges.py index 1ee4141..daf135b 100644 --- a/tests/api_resources/test_exchanges.py +++ b/tests/api_resources/test_exchanges.py @@ -62,7 +62,7 @@ def test_streaming_response_get(self, client: Coingecko) -> None: @parametrize def test_method_get_id(self, client: Coingecko) -> None: exchange = client.exchanges.get_id( - id="binance", + id="id", ) assert_matches_type(ExchangeGetIDResponse, exchange, path=["response"]) @@ -70,7 +70,7 @@ def test_method_get_id(self, client: Coingecko) -> None: @parametrize def test_method_get_id_with_all_params(self, client: Coingecko) -> None: exchange = client.exchanges.get_id( - id="binance", + id="id", dex_pair_format="contract_address", ) assert_matches_type(ExchangeGetIDResponse, exchange, path=["response"]) @@ -79,7 +79,7 @@ def test_method_get_id_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_id(self, client: Coingecko) -> None: response = client.exchanges.with_raw_response.get_id( - id="binance", + id="id", ) assert response.is_closed is True @@ -91,7 +91,7 @@ def test_raw_response_get_id(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_id(self, client: Coingecko) -> None: with client.exchanges.with_streaming_response.get_id( - id="binance", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -192,7 +192,7 @@ async def test_streaming_response_get(self, async_client: AsyncCoingecko) -> Non @parametrize async def test_method_get_id(self, async_client: AsyncCoingecko) -> None: exchange = await async_client.exchanges.get_id( - id="binance", + id="id", ) assert_matches_type(ExchangeGetIDResponse, exchange, path=["response"]) @@ -200,7 +200,7 @@ async def test_method_get_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_id_with_all_params(self, async_client: AsyncCoingecko) -> None: exchange = await async_client.exchanges.get_id( - id="binance", + id="id", dex_pair_format="contract_address", ) assert_matches_type(ExchangeGetIDResponse, exchange, path=["response"]) @@ -209,7 +209,7 @@ async def test_method_get_id_with_all_params(self, async_client: AsyncCoingecko) @parametrize async def test_raw_response_get_id(self, async_client: AsyncCoingecko) -> None: response = await async_client.exchanges.with_raw_response.get_id( - id="binance", + id="id", ) assert response.is_closed is True @@ -221,7 +221,7 @@ async def test_raw_response_get_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get_id(self, async_client: AsyncCoingecko) -> None: async with async_client.exchanges.with_streaming_response.get_id( - id="binance", + id="id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/test_news.py b/tests/api_resources/test_news.py index 6eab75b..6254a70 100644 --- a/tests/api_resources/test_news.py +++ b/tests/api_resources/test_news.py @@ -29,8 +29,8 @@ def test_method_get_with_all_params(self, client: Coingecko) -> None: news = client.news.get( coin_id="coin_id", language="en", - page=1, - per_page=1, + page=0, + per_page=0, type="all", ) assert_matches_type(NewsGetResponse, news, path=["response"]) @@ -75,8 +75,8 @@ async def test_method_get_with_all_params(self, async_client: AsyncCoingecko) -> news = await async_client.news.get( coin_id="coin_id", language="en", - page=1, - per_page=1, + page=0, + per_page=0, type="all", ) assert_matches_type(NewsGetResponse, news, path=["response"]) diff --git a/tests/api_resources/test_nfts.py b/tests/api_resources/test_nfts.py index a6406c1..a4f7b00 100644 --- a/tests/api_resources/test_nfts.py +++ b/tests/api_resources/test_nfts.py @@ -25,7 +25,7 @@ class TestNFTs: @parametrize def test_method_get_id(self, client: Coingecko) -> None: nft = client.nfts.get_id( - "pudgy-penguins", + "id", ) assert_matches_type(NFTGetIDResponse, nft, path=["response"]) @@ -33,7 +33,7 @@ def test_method_get_id(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_id(self, client: Coingecko) -> None: response = client.nfts.with_raw_response.get_id( - "pudgy-penguins", + "id", ) assert response.is_closed is True @@ -45,7 +45,7 @@ def test_raw_response_get_id(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_id(self, client: Coingecko) -> None: with client.nfts.with_streaming_response.get_id( - "pudgy-penguins", + "id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -111,7 +111,7 @@ def test_method_get_markets(self, client: Coingecko) -> None: @parametrize def test_method_get_markets_with_all_params(self, client: Coingecko) -> None: nft = client.nfts.get_markets( - asset_platform_id="ethereum", + asset_platform_id="asset_platform_id", order="h24_volume_native_asc", page=0, per_page=0, @@ -150,7 +150,7 @@ class TestAsyncNFTs: @parametrize async def test_method_get_id(self, async_client: AsyncCoingecko) -> None: nft = await async_client.nfts.get_id( - "pudgy-penguins", + "id", ) assert_matches_type(NFTGetIDResponse, nft, path=["response"]) @@ -158,7 +158,7 @@ async def test_method_get_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get_id(self, async_client: AsyncCoingecko) -> None: response = await async_client.nfts.with_raw_response.get_id( - "pudgy-penguins", + "id", ) assert response.is_closed is True @@ -170,7 +170,7 @@ async def test_raw_response_get_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_streaming_response_get_id(self, async_client: AsyncCoingecko) -> None: async with async_client.nfts.with_streaming_response.get_id( - "pudgy-penguins", + "id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -236,7 +236,7 @@ async def test_method_get_markets(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_markets_with_all_params(self, async_client: AsyncCoingecko) -> None: nft = await async_client.nfts.get_markets( - asset_platform_id="ethereum", + asset_platform_id="asset_platform_id", order="h24_volume_native_asc", page=0, per_page=0, diff --git a/tests/api_resources/test_public_treasury.py b/tests/api_resources/test_public_treasury.py index 2c2d2d2..dd4c8b7 100644 --- a/tests/api_resources/test_public_treasury.py +++ b/tests/api_resources/test_public_treasury.py @@ -26,7 +26,7 @@ class TestPublicTreasury: @parametrize def test_method_get_coin_id(self, client: Coingecko) -> None: public_treasury = client.public_treasury.get_coin_id( - coin_id="bitcoin", + coin_id="coin_id", entity="companies", ) assert_matches_type(PublicTreasuryGetCoinIDResponse, public_treasury, path=["response"]) @@ -35,11 +35,11 @@ def test_method_get_coin_id(self, client: Coingecko) -> None: @parametrize def test_method_get_coin_id_with_all_params(self, client: Coingecko) -> None: public_treasury = client.public_treasury.get_coin_id( - coin_id="bitcoin", + coin_id="coin_id", entity="companies", order="total_holdings_usd_desc", - page=1, - per_page=250, + page=0, + per_page=0, ) assert_matches_type(PublicTreasuryGetCoinIDResponse, public_treasury, path=["response"]) @@ -47,7 +47,7 @@ def test_method_get_coin_id_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_coin_id(self, client: Coingecko) -> None: response = client.public_treasury.with_raw_response.get_coin_id( - coin_id="bitcoin", + coin_id="coin_id", entity="companies", ) @@ -60,7 +60,7 @@ def test_raw_response_get_coin_id(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_coin_id(self, client: Coingecko) -> None: with client.public_treasury.with_streaming_response.get_coin_id( - coin_id="bitcoin", + coin_id="coin_id", entity="companies", ) as response: assert not response.is_closed @@ -84,7 +84,7 @@ def test_path_params_get_coin_id(self, client: Coingecko) -> None: @parametrize def test_method_get_entity_id(self, client: Coingecko) -> None: public_treasury = client.public_treasury.get_entity_id( - entity_id="strategy", + entity_id="entity_id", ) assert_matches_type(PublicTreasuryGetEntityIDResponse, public_treasury, path=["response"]) @@ -92,7 +92,7 @@ def test_method_get_entity_id(self, client: Coingecko) -> None: @parametrize def test_method_get_entity_id_with_all_params(self, client: Coingecko) -> None: public_treasury = client.public_treasury.get_entity_id( - entity_id="strategy", + entity_id="entity_id", holding_amount_change="holding_amount_change", holding_change_percentage="holding_change_percentage", ) @@ -102,7 +102,7 @@ def test_method_get_entity_id_with_all_params(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_entity_id(self, client: Coingecko) -> None: response = client.public_treasury.with_raw_response.get_entity_id( - entity_id="strategy", + entity_id="entity_id", ) assert response.is_closed is True @@ -114,7 +114,7 @@ def test_raw_response_get_entity_id(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_entity_id(self, client: Coingecko) -> None: with client.public_treasury.with_streaming_response.get_entity_id( - entity_id="strategy", + entity_id="entity_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -136,8 +136,8 @@ def test_path_params_get_entity_id(self, client: Coingecko) -> None: @parametrize def test_method_get_holding_chart(self, client: Coingecko) -> None: public_treasury = client.public_treasury.get_holding_chart( - coin_id="bitcoin", - entity_id="strategy", + coin_id="coin_id", + entity_id="entity_id", days="days", ) assert_matches_type(PublicTreasuryGetHoldingChartResponse, public_treasury, path=["response"]) @@ -146,8 +146,8 @@ def test_method_get_holding_chart(self, client: Coingecko) -> None: @parametrize def test_method_get_holding_chart_with_all_params(self, client: Coingecko) -> None: public_treasury = client.public_treasury.get_holding_chart( - coin_id="bitcoin", - entity_id="strategy", + coin_id="coin_id", + entity_id="entity_id", days="days", include_empty_intervals=True, ) @@ -157,8 +157,8 @@ def test_method_get_holding_chart_with_all_params(self, client: Coingecko) -> No @parametrize def test_raw_response_get_holding_chart(self, client: Coingecko) -> None: response = client.public_treasury.with_raw_response.get_holding_chart( - coin_id="bitcoin", - entity_id="strategy", + coin_id="coin_id", + entity_id="entity_id", days="days", ) @@ -171,8 +171,8 @@ def test_raw_response_get_holding_chart(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_holding_chart(self, client: Coingecko) -> None: with client.public_treasury.with_streaming_response.get_holding_chart( - coin_id="bitcoin", - entity_id="strategy", + coin_id="coin_id", + entity_id="entity_id", days="days", ) as response: assert not response.is_closed @@ -188,7 +188,7 @@ def test_streaming_response_get_holding_chart(self, client: Coingecko) -> None: def test_path_params_get_holding_chart(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `entity_id` but received ''"): client.public_treasury.with_raw_response.get_holding_chart( - coin_id="bitcoin", + coin_id="coin_id", entity_id="", days="days", ) @@ -196,7 +196,7 @@ def test_path_params_get_holding_chart(self, client: Coingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `coin_id` but received ''"): client.public_treasury.with_raw_response.get_holding_chart( coin_id="", - entity_id="strategy", + entity_id="entity_id", days="days", ) @@ -204,7 +204,7 @@ def test_path_params_get_holding_chart(self, client: Coingecko) -> None: @parametrize def test_method_get_transaction_history(self, client: Coingecko) -> None: public_treasury = client.public_treasury.get_transaction_history( - entity_id="strategy", + entity_id="entity_id", ) assert_matches_type(PublicTreasuryGetTransactionHistoryResponse, public_treasury, path=["response"]) @@ -212,7 +212,7 @@ def test_method_get_transaction_history(self, client: Coingecko) -> None: @parametrize def test_method_get_transaction_history_with_all_params(self, client: Coingecko) -> None: public_treasury = client.public_treasury.get_transaction_history( - entity_id="strategy", + entity_id="entity_id", coin_ids="coin_ids", order="date_desc", page=0, @@ -224,7 +224,7 @@ def test_method_get_transaction_history_with_all_params(self, client: Coingecko) @parametrize def test_raw_response_get_transaction_history(self, client: Coingecko) -> None: response = client.public_treasury.with_raw_response.get_transaction_history( - entity_id="strategy", + entity_id="entity_id", ) assert response.is_closed is True @@ -236,7 +236,7 @@ def test_raw_response_get_transaction_history(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_transaction_history(self, client: Coingecko) -> None: with client.public_treasury.with_streaming_response.get_transaction_history( - entity_id="strategy", + entity_id="entity_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -264,7 +264,7 @@ class TestAsyncPublicTreasury: @parametrize async def test_method_get_coin_id(self, async_client: AsyncCoingecko) -> None: public_treasury = await async_client.public_treasury.get_coin_id( - coin_id="bitcoin", + coin_id="coin_id", entity="companies", ) assert_matches_type(PublicTreasuryGetCoinIDResponse, public_treasury, path=["response"]) @@ -273,11 +273,11 @@ async def test_method_get_coin_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_coin_id_with_all_params(self, async_client: AsyncCoingecko) -> None: public_treasury = await async_client.public_treasury.get_coin_id( - coin_id="bitcoin", + coin_id="coin_id", entity="companies", order="total_holdings_usd_desc", - page=1, - per_page=250, + page=0, + per_page=0, ) assert_matches_type(PublicTreasuryGetCoinIDResponse, public_treasury, path=["response"]) @@ -285,7 +285,7 @@ async def test_method_get_coin_id_with_all_params(self, async_client: AsyncCoing @parametrize async def test_raw_response_get_coin_id(self, async_client: AsyncCoingecko) -> None: response = await async_client.public_treasury.with_raw_response.get_coin_id( - coin_id="bitcoin", + coin_id="coin_id", entity="companies", ) @@ -298,7 +298,7 @@ async def test_raw_response_get_coin_id(self, async_client: AsyncCoingecko) -> N @parametrize async def test_streaming_response_get_coin_id(self, async_client: AsyncCoingecko) -> None: async with async_client.public_treasury.with_streaming_response.get_coin_id( - coin_id="bitcoin", + coin_id="coin_id", entity="companies", ) as response: assert not response.is_closed @@ -322,7 +322,7 @@ async def test_path_params_get_coin_id(self, async_client: AsyncCoingecko) -> No @parametrize async def test_method_get_entity_id(self, async_client: AsyncCoingecko) -> None: public_treasury = await async_client.public_treasury.get_entity_id( - entity_id="strategy", + entity_id="entity_id", ) assert_matches_type(PublicTreasuryGetEntityIDResponse, public_treasury, path=["response"]) @@ -330,7 +330,7 @@ async def test_method_get_entity_id(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_method_get_entity_id_with_all_params(self, async_client: AsyncCoingecko) -> None: public_treasury = await async_client.public_treasury.get_entity_id( - entity_id="strategy", + entity_id="entity_id", holding_amount_change="holding_amount_change", holding_change_percentage="holding_change_percentage", ) @@ -340,7 +340,7 @@ async def test_method_get_entity_id_with_all_params(self, async_client: AsyncCoi @parametrize async def test_raw_response_get_entity_id(self, async_client: AsyncCoingecko) -> None: response = await async_client.public_treasury.with_raw_response.get_entity_id( - entity_id="strategy", + entity_id="entity_id", ) assert response.is_closed is True @@ -352,7 +352,7 @@ async def test_raw_response_get_entity_id(self, async_client: AsyncCoingecko) -> @parametrize async def test_streaming_response_get_entity_id(self, async_client: AsyncCoingecko) -> None: async with async_client.public_treasury.with_streaming_response.get_entity_id( - entity_id="strategy", + entity_id="entity_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -374,8 +374,8 @@ async def test_path_params_get_entity_id(self, async_client: AsyncCoingecko) -> @parametrize async def test_method_get_holding_chart(self, async_client: AsyncCoingecko) -> None: public_treasury = await async_client.public_treasury.get_holding_chart( - coin_id="bitcoin", - entity_id="strategy", + coin_id="coin_id", + entity_id="entity_id", days="days", ) assert_matches_type(PublicTreasuryGetHoldingChartResponse, public_treasury, path=["response"]) @@ -384,8 +384,8 @@ async def test_method_get_holding_chart(self, async_client: AsyncCoingecko) -> N @parametrize async def test_method_get_holding_chart_with_all_params(self, async_client: AsyncCoingecko) -> None: public_treasury = await async_client.public_treasury.get_holding_chart( - coin_id="bitcoin", - entity_id="strategy", + coin_id="coin_id", + entity_id="entity_id", days="days", include_empty_intervals=True, ) @@ -395,8 +395,8 @@ async def test_method_get_holding_chart_with_all_params(self, async_client: Asyn @parametrize async def test_raw_response_get_holding_chart(self, async_client: AsyncCoingecko) -> None: response = await async_client.public_treasury.with_raw_response.get_holding_chart( - coin_id="bitcoin", - entity_id="strategy", + coin_id="coin_id", + entity_id="entity_id", days="days", ) @@ -409,8 +409,8 @@ async def test_raw_response_get_holding_chart(self, async_client: AsyncCoingecko @parametrize async def test_streaming_response_get_holding_chart(self, async_client: AsyncCoingecko) -> None: async with async_client.public_treasury.with_streaming_response.get_holding_chart( - coin_id="bitcoin", - entity_id="strategy", + coin_id="coin_id", + entity_id="entity_id", days="days", ) as response: assert not response.is_closed @@ -426,7 +426,7 @@ async def test_streaming_response_get_holding_chart(self, async_client: AsyncCoi async def test_path_params_get_holding_chart(self, async_client: AsyncCoingecko) -> None: with pytest.raises(ValueError, match=r"Expected a non-empty value for `entity_id` but received ''"): await async_client.public_treasury.with_raw_response.get_holding_chart( - coin_id="bitcoin", + coin_id="coin_id", entity_id="", days="days", ) @@ -434,7 +434,7 @@ async def test_path_params_get_holding_chart(self, async_client: AsyncCoingecko) with pytest.raises(ValueError, match=r"Expected a non-empty value for `coin_id` but received ''"): await async_client.public_treasury.with_raw_response.get_holding_chart( coin_id="", - entity_id="strategy", + entity_id="entity_id", days="days", ) @@ -442,7 +442,7 @@ async def test_path_params_get_holding_chart(self, async_client: AsyncCoingecko) @parametrize async def test_method_get_transaction_history(self, async_client: AsyncCoingecko) -> None: public_treasury = await async_client.public_treasury.get_transaction_history( - entity_id="strategy", + entity_id="entity_id", ) assert_matches_type(PublicTreasuryGetTransactionHistoryResponse, public_treasury, path=["response"]) @@ -450,7 +450,7 @@ async def test_method_get_transaction_history(self, async_client: AsyncCoingecko @parametrize async def test_method_get_transaction_history_with_all_params(self, async_client: AsyncCoingecko) -> None: public_treasury = await async_client.public_treasury.get_transaction_history( - entity_id="strategy", + entity_id="entity_id", coin_ids="coin_ids", order="date_desc", page=0, @@ -462,7 +462,7 @@ async def test_method_get_transaction_history_with_all_params(self, async_client @parametrize async def test_raw_response_get_transaction_history(self, async_client: AsyncCoingecko) -> None: response = await async_client.public_treasury.with_raw_response.get_transaction_history( - entity_id="strategy", + entity_id="entity_id", ) assert response.is_closed is True @@ -474,7 +474,7 @@ async def test_raw_response_get_transaction_history(self, async_client: AsyncCoi @parametrize async def test_streaming_response_get_transaction_history(self, async_client: AsyncCoingecko) -> None: async with async_client.public_treasury.with_streaming_response.get_transaction_history( - entity_id="strategy", + entity_id="entity_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/test_token_lists.py b/tests/api_resources/test_token_lists.py index f4432a9..b5a1fa4 100644 --- a/tests/api_resources/test_token_lists.py +++ b/tests/api_resources/test_token_lists.py @@ -21,7 +21,7 @@ class TestTokenLists: @parametrize def test_method_get_all_json(self, client: Coingecko) -> None: token_list = client.token_lists.get_all_json( - "ethereum", + "asset_platform_id", ) assert_matches_type(TokenListGetAllJsonResponse, token_list, path=["response"]) @@ -29,7 +29,7 @@ def test_method_get_all_json(self, client: Coingecko) -> None: @parametrize def test_raw_response_get_all_json(self, client: Coingecko) -> None: response = client.token_lists.with_raw_response.get_all_json( - "ethereum", + "asset_platform_id", ) assert response.is_closed is True @@ -41,7 +41,7 @@ def test_raw_response_get_all_json(self, client: Coingecko) -> None: @parametrize def test_streaming_response_get_all_json(self, client: Coingecko) -> None: with client.token_lists.with_streaming_response.get_all_json( - "ethereum", + "asset_platform_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -69,7 +69,7 @@ class TestAsyncTokenLists: @parametrize async def test_method_get_all_json(self, async_client: AsyncCoingecko) -> None: token_list = await async_client.token_lists.get_all_json( - "ethereum", + "asset_platform_id", ) assert_matches_type(TokenListGetAllJsonResponse, token_list, path=["response"]) @@ -77,7 +77,7 @@ async def test_method_get_all_json(self, async_client: AsyncCoingecko) -> None: @parametrize async def test_raw_response_get_all_json(self, async_client: AsyncCoingecko) -> None: response = await async_client.token_lists.with_raw_response.get_all_json( - "ethereum", + "asset_platform_id", ) assert response.is_closed is True @@ -89,7 +89,7 @@ async def test_raw_response_get_all_json(self, async_client: AsyncCoingecko) -> @parametrize async def test_streaming_response_get_all_json(self, async_client: AsyncCoingecko) -> None: async with async_client.token_lists.with_streaming_response.get_all_json( - "ethereum", + "asset_platform_id", ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" From 165a3eacb2e33710efc212a0c3973d079e03266c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 28 May 2026 15:27:01 +0000 Subject: [PATCH 7/8] fix(api): InferUnionVariantName for PublicTreasury --- .stats.yml | 4 ++-- .../public_treasury_get_coin_id_response.py | 22 +++++++++---------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.stats.yml b/.stats.yml index e75eb53..1db6146 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 85 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/coingecko/coingecko-b079f01bc2666934105058a09411c02697a2af430c4bfbce18a007a962993b72.yml -openapi_spec_hash: 89fa5081bcee8c6dbac9e2cf7cf2257b +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/coingecko/coingecko-901d4a638386875c664326acd4bee6ee2920af6750d34805fb180b255ba6c9d6.yml +openapi_spec_hash: 8809e5886b08ff5ddd8f655b951ef247 config_hash: 9027ea229c330039b86c690ff1bf3fce diff --git a/src/coingecko_sdk/types/public_treasury_get_coin_id_response.py b/src/coingecko_sdk/types/public_treasury_get_coin_id_response.py index 2b7ef3b..c654f89 100644 --- a/src/coingecko_sdk/types/public_treasury_get_coin_id_response.py +++ b/src/coingecko_sdk/types/public_treasury_get_coin_id_response.py @@ -7,14 +7,14 @@ __all__ = [ "PublicTreasuryGetCoinIDResponse", - "UnionMember0", - "UnionMember0Company", - "UnionMember1", - "UnionMember1Government", + "CompanyTreasury", + "CompanyTreasuryCompany", + "GovernmentTreasury", + "GovernmentTreasuryGovernment", ] -class UnionMember0Company(BaseModel): +class CompanyTreasuryCompany(BaseModel): country: str """Country code""" @@ -37,8 +37,8 @@ class UnionMember0Company(BaseModel): """Total crypto holdings""" -class UnionMember0(BaseModel): - companies: List[UnionMember0Company] +class CompanyTreasury(BaseModel): + companies: List[CompanyTreasuryCompany] """List of companies holding crypto""" market_cap_dominance: float @@ -51,7 +51,7 @@ class UnionMember0(BaseModel): """Total crypto holdings value in USD""" -class UnionMember1Government(BaseModel): +class GovernmentTreasuryGovernment(BaseModel): country: str """Country code""" @@ -74,8 +74,8 @@ class UnionMember1Government(BaseModel): """Total crypto holdings""" -class UnionMember1(BaseModel): - governments: List[UnionMember1Government] +class GovernmentTreasury(BaseModel): + governments: List[GovernmentTreasuryGovernment] """List of governments holding crypto""" market_cap_dominance: float @@ -88,4 +88,4 @@ class UnionMember1(BaseModel): """Total crypto holdings value in USD""" -PublicTreasuryGetCoinIDResponse: TypeAlias = Union[UnionMember0, UnionMember1] +PublicTreasuryGetCoinIDResponse: TypeAlias = Union[CompanyTreasury, GovernmentTreasury] From 863e6aad445c2cbee673a187363205390b37c38e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 28 May 2026 15:27:32 +0000 Subject: [PATCH 8/8] release: 3.0.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 28 ++++++++++++++++++++++++++++ pyproject.toml | 2 +- src/coingecko_sdk/_version.py | 2 +- 4 files changed, 31 insertions(+), 3 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index cf72398..4191c88 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "2.0.1" + ".": "3.0.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 1a7f5c6..a493cac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,33 @@ # Changelog +## 3.0.0 (2026-05-28) + +Full Changelog: [v2.0.1...v3.0.0](https://github.com/coingecko/coingecko-python/compare/v2.0.1...v3.0.0) + +### ⚠ BREAKING CHANGES + +* Methods refresh + +### Features + +* **internal/types:** support eagerly validating pydantic iterators ([c6c8ef9](https://github.com/coingecko/coingecko-python/commit/c6c8ef9a176183c52f134c1a81bb0f8eec3fb832)) + + +### Bug Fixes + +* **api:** InferUnionVariantName for PublicTreasury ([165a3ea](https://github.com/coingecko/coingecko-python/commit/165a3eacb2e33710efc212a0c3973d079e03266c)) +* **client:** add missing f-string prefix in file type error message ([3852f84](https://github.com/coingecko/coingecko-python/commit/3852f84ead0b60a88a936e52309aee30a0743030)) + + +### Chores + +* **internal:** reformat pyproject.toml ([f32c0f3](https://github.com/coingecko/coingecko-python/commit/f32c0f3d2e71c274c00f2b5e9608be42c5e5169b)) + + +### Refactors + +* Methods refresh ([44e2ae6](https://github.com/coingecko/coingecko-python/commit/44e2ae67a350de62ced124dfb85f9c6083d57aed)) + ## 2.0.1 (2026-04-30) Full Changelog: [v2.0.0...v2.0.1](https://github.com/coingecko/coingecko-python/compare/v2.0.0...v2.0.1) diff --git a/pyproject.toml b/pyproject.toml index 0c3701c..73cc9a9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "coingecko_sdk" -version = "2.0.1" +version = "3.0.0" description = "The official Python library for the coingecko API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/coingecko_sdk/_version.py b/src/coingecko_sdk/_version.py index 7a2b6d2..4e01fea 100644 --- a/src/coingecko_sdk/_version.py +++ b/src/coingecko_sdk/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "coingecko_sdk" -__version__ = "2.0.1" # x-release-please-version +__version__ = "3.0.0" # x-release-please-version