crypticorn 2.11.0__py3-none-any.whl → 2.11.5__py3-none-any.whl

crypticorn/metrics/client/api/marketcap_api.py

@@ -21,6 +21,9 @@ from typing import Any, Dict, List, Optional
 from typing_extensions import Annotated
 from crypticorn.metrics.client.models.market_type import MarketType
 from crypticorn.metrics.client.models.marketcap_ranking import MarketcapRanking
+from crypticorn.metrics.client.models.marketcap_symbol_ranking import (
+    MarketcapSymbolRanking,
+)
 from crypticorn.metrics.client.models.ohlcv import OHLCV
 
 from crypticorn.metrics.client.api_client import ApiClient, RequestSerialized
@@ -313,7 +316,7 @@ class MarketcapApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Dict[str, object]]:
+    ) -> List[MarketcapRanking]:
         """Get Marketcap Between Timestamps
 
         Retrieve marketcap data between timestamps.
@@ -354,7 +357,7 @@ class MarketcapApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[Dict[str, object]]",
+            "200": "List[MarketcapRanking]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -385,7 +388,7 @@ class MarketcapApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Dict[str, object]]]:
+    ) -> ApiResponse[List[MarketcapRanking]]:
         """Get Marketcap Between Timestamps
 
         Retrieve marketcap data between timestamps.
@@ -426,7 +429,7 @@ class MarketcapApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[Dict[str, object]]",
+            "200": "List[MarketcapRanking]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -498,7 +501,7 @@ class MarketcapApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[Dict[str, object]]",
+            "200": "List[MarketcapRanking]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -581,11 +584,15 @@ class MarketcapApi:
         ] = None,
         market: Annotated[
             Optional[MarketType],
-            Field(description="Market for which to fetch symbols and marketcap data"),
+            Field(
+                description="Market for which to fetch symbols and marketcap data. Defaults to futures."
+            ),
         ] = None,
         exchange: Annotated[
             Optional[StrictStr],
-            Field(description="Exchange for which to fetch symbols and marketcap data"),
+            Field(
+                description="Exchange for which to fetch symbols and marketcap data. If not provided, all exchanges will be returned."
+            ),
         ] = None,
         _request_timeout: Union[
             None,
@@ -598,10 +605,10 @@ class MarketcapApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[MarketcapRanking]:
+    ) -> List[MarketcapSymbolRanking]:
         """Get Symbols Marketcap Between Timestamps
 
-        Retrieve marketcap data for symbols between timestamps with optional filtering.
+        Retrieve a ranking of symbols by marketcap between timestamps.
 
         :param start_timestamp: Start timestamp
         :type start_timestamp: int
@@ -609,9 +616,9 @@ class MarketcapApi:
         :type end_timestamp: int
         :param interval: Interval for which to fetch symbols and marketcap data
         :type interval: str
-        :param market: Market for which to fetch symbols and marketcap data
+        :param market: Market for which to fetch symbols and marketcap data. Defaults to futures.
         :type market: MarketType
-        :param exchange: Exchange for which to fetch symbols and marketcap data
+        :param exchange: Exchange for which to fetch symbols and marketcap data. If not provided, all exchanges will be returned.
         :type exchange: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -648,7 +655,7 @@ class MarketcapApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[MarketcapRanking]",
+            "200": "List[MarketcapSymbolRanking]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -674,11 +681,15 @@ class MarketcapApi:
         ] = None,
         market: Annotated[
             Optional[MarketType],
-            Field(description="Market for which to fetch symbols and marketcap data"),
+            Field(
+                description="Market for which to fetch symbols and marketcap data. Defaults to futures."
+            ),
         ] = None,
         exchange: Annotated[
             Optional[StrictStr],
-            Field(description="Exchange for which to fetch symbols and marketcap data"),
+            Field(
+                description="Exchange for which to fetch symbols and marketcap data. If not provided, all exchanges will be returned."
+            ),
         ] = None,
         _request_timeout: Union[
             None,
@@ -691,10 +702,10 @@ class MarketcapApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[MarketcapRanking]]:
+    ) -> ApiResponse[List[MarketcapSymbolRanking]]:
         """Get Symbols Marketcap Between Timestamps
 
-        Retrieve marketcap data for symbols between timestamps with optional filtering.
+        Retrieve a ranking of symbols by marketcap between timestamps.
 
         :param start_timestamp: Start timestamp
         :type start_timestamp: int
@@ -702,9 +713,9 @@ class MarketcapApi:
         :type end_timestamp: int
         :param interval: Interval for which to fetch symbols and marketcap data
         :type interval: str
-        :param market: Market for which to fetch symbols and marketcap data
+        :param market: Market for which to fetch symbols and marketcap data. Defaults to futures.
         :type market: MarketType
-        :param exchange: Exchange for which to fetch symbols and marketcap data
+        :param exchange: Exchange for which to fetch symbols and marketcap data. If not provided, all exchanges will be returned.
         :type exchange: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -741,7 +752,7 @@ class MarketcapApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[MarketcapRanking]",
+            "200": "List[MarketcapSymbolRanking]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -767,11 +778,15 @@ class MarketcapApi:
         ] = None,
         market: Annotated[
             Optional[MarketType],
-            Field(description="Market for which to fetch symbols and marketcap data"),
+            Field(
+                description="Market for which to fetch symbols and marketcap data. Defaults to futures."
+            ),
         ] = None,
         exchange: Annotated[
             Optional[StrictStr],
-            Field(description="Exchange for which to fetch symbols and marketcap data"),
+            Field(
+                description="Exchange for which to fetch symbols and marketcap data. If not provided, all exchanges will be returned."
+            ),
         ] = None,
         _request_timeout: Union[
             None,
@@ -787,7 +802,7 @@ class MarketcapApi:
     ) -> RESTResponseType:
         """Get Symbols Marketcap Between Timestamps
 
-        Retrieve marketcap data for symbols between timestamps with optional filtering.
+        Retrieve a ranking of symbols by marketcap between timestamps.
 
         :param start_timestamp: Start timestamp
         :type start_timestamp: int
@@ -795,9 +810,9 @@ class MarketcapApi:
         :type end_timestamp: int
         :param interval: Interval for which to fetch symbols and marketcap data
         :type interval: str
-        :param market: Market for which to fetch symbols and marketcap data
+        :param market: Market for which to fetch symbols and marketcap data. Defaults to futures.
         :type market: MarketType
-        :param exchange: Exchange for which to fetch symbols and marketcap data
+        :param exchange: Exchange for which to fetch symbols and marketcap data. If not provided, all exchanges will be returned.
         :type exchange: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -834,7 +849,7 @@ class MarketcapApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[MarketcapRanking]",
+            "200": "List[MarketcapSymbolRanking]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -928,7 +943,8 @@ class MarketcapApi:
             Optional[StrictStr], Field(description="Timeframe for OHLCV data")
         ] = None,
         market: Annotated[
-            Optional[MarketType], Field(description="Market for OHLCV data")
+            Optional[MarketType],
+            Field(description="Market for OHLCV data. Defaults to futures."),
         ] = None,
         top_n: Annotated[
             Optional[StrictInt], Field(description="Number of symbols to fetch")
@@ -957,7 +973,7 @@ class MarketcapApi:
         :type timestamp: int
         :param timeframe: Timeframe for OHLCV data
         :type timeframe: str
-        :param market: Market for OHLCV data
+        :param market: Market for OHLCV data. Defaults to futures.
         :type market: MarketType
         :param top_n: Number of symbols to fetch
         :type top_n: int
@@ -1020,7 +1036,8 @@ class MarketcapApi:
             Optional[StrictStr], Field(description="Timeframe for OHLCV data")
         ] = None,
         market: Annotated[
-            Optional[MarketType], Field(description="Market for OHLCV data")
+            Optional[MarketType],
+            Field(description="Market for OHLCV data. Defaults to futures."),
         ] = None,
         top_n: Annotated[
             Optional[StrictInt], Field(description="Number of symbols to fetch")
@@ -1049,7 +1066,7 @@ class MarketcapApi:
         :type timestamp: int
         :param timeframe: Timeframe for OHLCV data
         :type timeframe: str
-        :param market: Market for OHLCV data
+        :param market: Market for OHLCV data. Defaults to futures.
         :type market: MarketType
         :param top_n: Number of symbols to fetch
         :type top_n: int
@@ -1112,7 +1129,8 @@ class MarketcapApi:
             Optional[StrictStr], Field(description="Timeframe for OHLCV data")
         ] = None,
         market: Annotated[
-            Optional[MarketType], Field(description="Market for OHLCV data")
+            Optional[MarketType],
+            Field(description="Market for OHLCV data. Defaults to futures."),
         ] = None,
         top_n: Annotated[
             Optional[StrictInt], Field(description="Number of symbols to fetch")
@@ -1141,7 +1159,7 @@ class MarketcapApi:
         :type timestamp: int
         :param timeframe: Timeframe for OHLCV data
         :type timeframe: str
-        :param market: Market for OHLCV data
+        :param market: Market for OHLCV data. Defaults to futures.
         :type market: MarketType
         :param top_n: Number of symbols to fetch
         :type top_n: int

crypticorn/metrics/client/configuration.py

@@ -215,7 +215,7 @@ class Configuration:
         debug: Optional[bool] = None,
     ) -> None:
         """Constructor"""
-        self._base_path = "http://127.0.0.1:8000/v1/metrics" if host is None else host
+        self._base_path = "http://localhost/v1/metrics" if host is None else host
         """Default Base url
         """
         self.server_index = 0 if server_index is None and host is None else server_index
@@ -557,7 +557,7 @@ class Configuration:
         """
         return [
             {
-                "url": "http://127.0.0.1:8000/v1/metrics",
+                "url": "http://localhost/v1/metrics",
                 "description": "No description provided",
             }
         ]

crypticorn/metrics/client/models/__init__.py

@@ -18,11 +18,15 @@ from crypticorn.metrics.client.models.api_error_identifier import ApiErrorIdenti
 from crypticorn.metrics.client.models.api_error_level import ApiErrorLevel
 from crypticorn.metrics.client.models.api_error_type import ApiErrorType
 from crypticorn.metrics.client.models.exception_detail import ExceptionDetail
+from crypticorn.metrics.client.models.exchange_availability import ExchangeAvailability
 from crypticorn.metrics.client.models.exchange_mapping import ExchangeMapping
 from crypticorn.metrics.client.models.internal_exchange import InternalExchange
 from crypticorn.metrics.client.models.log_level import LogLevel
 from crypticorn.metrics.client.models.market_type import MarketType
 from crypticorn.metrics.client.models.marketcap_ranking import MarketcapRanking
+from crypticorn.metrics.client.models.marketcap_symbol_ranking import (
+    MarketcapSymbolRanking,
+)
 from crypticorn.metrics.client.models.ohlcv import OHLCV
 from crypticorn.metrics.client.models.severity import Severity
 from crypticorn.metrics.client.models.time_interval import TimeInterval

crypticorn/metrics/client/models/exchange_availability.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+Marketcap Service API
+
+API for retrieving historical marketcap data, available exchanges, and indicators.
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ExchangeAvailability(BaseModel):
+    """
+    ExchangeAvailability
+    """  # noqa: E501
+
+    timestamp: StrictInt = Field(description="The timestamp of the availability")
+    exchanges: Dict[str, StrictBool] = Field(
+        description="The availability of the exchange. Returns a dictionary of exchange names and their availability as a boolean."
+    )
+    __properties: ClassVar[List[str]] = ["timestamp", "exchanges"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ExchangeAvailability from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExchangeAvailability from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"timestamp": obj.get("timestamp"), "exchanges": obj.get("exchanges")}
+        )
+        return _obj

crypticorn/metrics/client/models/marketcap_ranking.py

@@ -17,20 +17,20 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Optional, Set
 from typing_extensions import Self
 
 
 class MarketcapRanking(BaseModel):
     """
-    MarketcapRanking
+    A ranking of symbols by marketcap at a given timestamp.
     """  # noqa: E501
 
     timestamp: StrictInt
-    symbols: List[Optional[StrictStr]]
-    __properties: ClassVar[List[str]] = ["timestamp", "symbols"]
+    marketcap_values: List[Optional[Union[StrictFloat, StrictInt]]]
+    __properties: ClassVar[List[str]] = ["timestamp", "marketcap_values"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -81,6 +81,9 @@ class MarketcapRanking(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate(
-            {"timestamp": obj.get("timestamp"), "symbols": obj.get("symbols")}
+            {
+                "timestamp": obj.get("timestamp"),
+                "marketcap_values": obj.get("marketcap_values"),
+            }
         )
         return _obj

crypticorn/metrics/client/models/marketcap_symbol_ranking.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+"""
+Marketcap Service API
+
+API for retrieving historical marketcap data, available exchanges, and indicators.
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class MarketcapSymbolRanking(BaseModel):
+    """
+    A ranking of marketcap values at a given timestamp.
+    """  # noqa: E501
+
+    timestamp: StrictInt
+    symbols: List[Optional[StrictStr]]
+    __properties: ClassVar[List[str]] = ["timestamp", "symbols"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MarketcapSymbolRanking from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MarketcapSymbolRanking from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"timestamp": obj.get("timestamp"), "symbols": obj.get("symbols")}
+        )
+        return _obj

crypticorn/metrics/main.py

@@ -54,7 +54,7 @@ class MarketcapApiWrapper(MarketcapApi):
         rows = []
         for item in response:
             row = {"timestamp": item.timestamp}
-            row.update({i+1: sym for i, sym in enumerate(item.symbols)})
+            row.update({i + 1: sym for i, sym in enumerate(item.symbols)})
             rows.append(row)
         df = pd.DataFrame(rows)
         return df
@@ -93,22 +93,15 @@ class ExchangesApiWrapper(ExchangesApi):
         """
         pd = optional_import("pandas", "extra")
         response = await self.get_available_exchanges(*args, **kwargs)
-        processed_results = []
-        for row in response:
-            data = {"timestamp": row["timestamp"]}
-            data.update(row["exchanges"])
-            processed_results.append(data)
-
-        # Create DataFrame and sort columns
-        df = pd.DataFrame(processed_results)
-        cols = ["timestamp"] + sorted([col for col in df.columns if col != "timestamp"])
-        df = df[cols]
-
-        # Convert exchange availability to boolean integers (0/1)
-        df = df.astype(
-            {
-                "timestamp": "int64",
-                **{col: "int8" for col in df.columns if col != "timestamp"},
-            }
-        )
+
+        # Create list of dictionaries with timestamp and flattened exchange data
+        rows = []
+        for item in response:
+            row = {"timestamp": item.timestamp}
+            row.update(
+                item.exchanges
+            )  # This spreads the exchanges dict into individual columns
+            rows.append(row)
+
+        df = pd.DataFrame(rows)
         return df

{crypticorn-2.11.0.dist-info → crypticorn-2.11.5.dist-info}/METADATA

@@ -1,23 +1,9 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.11.0
+Version: 2.11.5
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
-License: Copyright © 2025 Crypticorn
-        
-        All rights reserved. This software and accompanying documentation files (collectively referred to as "the Software") are the proprietary property of Crypticorn. Any unauthorised reproduction, modification, integration, publication, distribution, sublicensing, sale, or enabling access to the Software without explicit written permission from Crypticorn is strictly prohibited, subject to the conditions outlined herein:
-        
-        1. The aforementioned copyright notice and this permission notice must be included unaltered in all copies, or significant portions, of the Software.
-        
-        2. The Software is provided "AS IS", without any warranty, whether express or implied. Crypticorn expressly disclaims any guarantees, including but not limited to those of satisfactory quality, fitness for a particular purpose, or non-infringement of third-party rights.
-        
-        3. In no event shall Crypticorn, its authors, or copyright holders be held liable for any claim, damages, or other liability arising from or associated with the use of the Software or any other dealings involving the Software, to the extent that such liability can be limited or excluded by applicable law.
-        
-        Changes to this agreement may be made without notice, and it is the user's responsibility to keep abreast of any changes. This agreement and its interpretation are subject to the laws of the Federal Republic of Germany.
-        
-        If any provision of this license agreement is held to be invalid or unenforceable under applicable law, the remaining provisions will continue in full force and effect. Crypticorn's failure to enforce any provision of this agreement does not constitute a waiver of its right to do so in the future.
-        
-        This agreement is written in English. In the event of any discrepancy between the English version and any translation, the English version shall prevail.
+License-Expression: MIT
 Project-URL: Homepage, https://crypticorn.com
 Project-URL: Documentation, https://docs.crypticorn.com
 Project-URL: Dashboard, https://app.crypticorn.com
@@ -26,7 +12,6 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -99,7 +84,7 @@ from crypticorn import ApiClient
 ```
 The ApiClient serves as the central interface for API operations. It instantiates multiple API wrappers corresponding to our micro services. These are structured the following:
 
-<img src="pip-structure.svg" alt="pip package structure" />
+<img src="static/pip-structure.svg" alt="pip package structure" />
 
 You can either explore each API by clicking through the library or checkout the [API Documentation](https://docs.crypticorn.com/api).
 
@@ -116,7 +101,12 @@ from crypticorn.common import Scope, Exchange
 
 ## Authentication
 
-To get started, [create an API key in your dashboard](https://app.crypticorn.com/account/developer). Then instantiate the `ApiClient` class with your copied key.
+To get started, [create an API key in your dashboard](https://app.crypticorn.com/account/developer). 
+
+The scopes you can assign, resemble the [package structure](#structure). The first part defines if the scopes is for reading or writing a ressource, the second matches the API, the third the ROUTER being used. `read` scopes gives access to GET, `write` to PUT, PATCH, POST, DELETE endpoints. 
+
+There are scopes which don't follow this structure. Those are either scopes that must be purchased (e.g. `read:predictions`), give access to endpoints existing in all APIs (e.g. `read:admin`) or provide access to an entire service (e.g. `read:sentiment`).
+
 
 ## Basic Usage