Metadata-Version: 2.4
Name: kaikosdk
Version: 1.35.1
Summary: Kaiko SDK
Home-page: https://www.kaiko.com/
Author: Kaiko
Author-email: hello@kaiko.com
License: MIT
Description-Content-Type: text/markdown
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: summary

<p align="center">
  <img src="https://raw.githubusercontent.com/kaikodata/kaiko-go-sdk/master/logo.png" alt="Kaiko" width="300">
</p>

# kaikosdk

Python client library for the Kaiko gRPC API. This SDK provides auto-generated gRPC stubs for streaming cryptocurrency market data.

## Installation

```bash
pip install kaikosdk
```

## Requirements

- Python 3.9+
- A valid Kaiko API key

## Usage

```python
import grpc
from kaikosdk import sdk_pb2_grpc
from kaikosdk.stream.trades_v1 import request_pb2 as trades_request
from kaikosdk.core import instrument_criteria_pb2

channel = grpc.secure_channel("gateway-v0-grpc.kaiko.ovh:443", grpc.ssl_channel_credentials())
stub = sdk_pb2_grpc.StreamTradesServiceV1Stub(channel)

metadata = [("authorization", "Bearer <YOUR_API_KEY>")]

request = trades_request.StreamTradesRequestV1(
    instrument_criteria=instrument_criteria_pb2.InstrumentCriteria(
        exchange="cbse",
        instrument_class="spot",
        code="btc-usd",
    )
)

for response in stub.Subscribe(request, metadata=metadata):
    print(f"Trade: {response}")
```

## Available Services

All services expose a `Subscribe` method that returns a server-side stream.

| Service | Description |
|---------|-------------|
| `StreamTradesServiceV1` | Real-time trades |
| `StreamMarketUpdateServiceV1` | Market updates |
| `StreamAggregatedQuoteServiceV2` | Aggregated quotes |
| `StreamAggregatedPriceServiceV1` | Aggregated prices |
| `StreamAggregatedStatePriceServiceV1` | Aggregated state prices |
| `StreamAggregatesOHLCVServiceV1` | OHLCV aggregates |
| `StreamAggregatesVWAPServiceV1` | VWAP aggregates |
| `StreamAggregatesSpotExchangeRateV2ServiceV1` | Spot exchange rates |
| `StreamAggregatesSpotDirectExchangeRateV2ServiceV1` | Direct exchange rates |
| `StreamOrderbookL2ServiceV1` | Level 2 order book |
| `StreamOrderbookL2ReplayServiceV1` | Level 2 order book replay |
| `StreamIndexServiceV1` | Index values |
| `StreamIndexMultiAssetsServiceV1` | Multi-asset index values |
| `StreamIndexForexRateServiceV1` | Index forex rates |
| `StreamCompositeIndicesServiceV1` | Composite indices |
| `StreamConstantDurationIndicesServiceV1` | Constant duration indices |
| `StreamExoticIndicesServiceV1` | Exotic indices |
| `StreamDerivativesInstrumentMetricsServiceV1` | Derivatives instrument metrics |
| `StreamIvSviParametersServiceV1` | IV SVI parameters |

## Examples

For more complete examples, see the [kaiko-sdk-examples](https://github.com/kaikodata/kaiko-sdk-examples) repository.
