Skip to content

Latest commit

 

History

History
228 lines (161 loc) · 10.5 KB

README.md

File metadata and controls

228 lines (161 loc) · 10.5 KB
Raw

CoinAPI REST

Coverage Status Quality Gate Status Ruff image image

Installation

pip install coinapi-rest

Example Usage

Example

import coinapi

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metadata.get_v1_assets(filter_asset_id='<value>', include_supply=False)

if res.content is not None:
    # handle response
    pass

Available Resources and Operations

metadata

exchange_rates

indexes

metrics

order_book

order_book_l3

quotes

ohlcv

trades

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

Error Object Status Code Content Type
errors.CoinAPIError 4x-5xx /

Example

import coinapi
from coinapi.models import errors

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)

res = None
try:
    res = s.metadata.get_v1_assets(filter_asset_id='<value>', include_supply=False)
except errors.CoinAPIError as e:
    # handle exception
    raise (e)

if res.content is not None:
    # handle response
    pass

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://rest.coinapi.io None

Example

import coinapi

s = coinapi.CoinAPI(
    server_idx=0,
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metadata.get_v1_assets(filter_asset_id='<value>', include_supply=False)

if res.content is not None:
    # handle response
    pass

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

import coinapi

s = coinapi.CoinAPI(
    server_url="https://rest.coinapi.io",
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metadata.get_v1_assets(filter_asset_id='<value>', include_supply=False)

if res.content is not None:
    # handle response
    pass

Custom HTTP Client

The CoinAPI SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom httpx.Client object.

For example, you could specify a header for every request that this sdk makes as follows:

import coinapi
import httpx

http_client = httpx.Client(headers={'x-custom-header': 'someValue'})
s = coinapi.CoinAPI(api_key="<YOUR_API_KEY_HERE>", client=http_client)

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
api_key apiKey API key

To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:

import coinapi

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metadata.get_v1_assets(filter_asset_id='<value>', include_supply=False)

if res.content is not None:
    # handle response
    pass