bjarkan-sdk 0.1.13

A Python SDK for accessing the Historical Market Data API of Bjarkan

Bjarkan Market Data SDK

A Python SDK for accessing the Historical Market Data API of Bjarkan.

Installation

You can install the Bjarkan Market Data SDK using pip:

pip install bjarkan-sdk

Usage

Here's a quick example of how to use the SDK:

from bjarkan_client import BjarkanClient
from datetime import datetime

# Initialize the client
client = BjarkanClient("https://api.bjarkan.io")

# Authenticate
client.authenticate("your_username", "your_password")

# Get available tables
tables = client.get_tables()
print("Available tables:", tables)

# Get history for a specific table
result = client.get_history(
    table_name="example_table",
    start_time=datetime(2024, 10, 5, 15, 30, 00),
    end_time=datetime(2024, 10, 5, 15, 40, 00),
    exchange='binance',
    symbol="BTC/USDT",
    bucket_period="100ms",
    sort_descending=False
)
print("Data:", result['data'][:5])  # Print first 5 entries
print(f"Query performance: {result['query_performance_seconds']:.4f} seconds")

API Reference

BjarkanClient

__init__(base_url: str)

Initialize the client with the base URL of the Bjarkan Market Data API.

authenticate(username: str, password: str)

Authenticate with the API using your username and password.

get_tables() -> List[Dict[str, any]]

Get a list of available tables and their configurations.

get_history(table_name: str, start_time: datetime, end_time: datetime, exchange: str = None, symbol: str = None, sort_descending: bool = False, bucket_period: str = None, limit: int = None, offset: int = None) -> Dict[str, any]

Retrieve historical data for a specific table.

Returns a dictionary containing:

• data: List of historical data entries
• query_performance_seconds: Time taken to execute the query in seconds

get_paginated_history(table_name: str, start_time: datetime, end_time: datetime, exchange: str = None, symbol: str = None, sort_descending: bool = False, bucket_period: str = None, page_size: int = 1000) -> Iterator[Dict[str, any]]

Retrieve historical data in pages. Each iteration returns a dictionary containing:

• data: List of historical data entries for the current page
• query_performance_seconds: Time taken to execute the query for the current page in seconds

validate_bucket_period(bucket_period: str) -> bool

Validate if the given bucket period is valid.

License

This project is licensed under the MIT License - see the LICENSE file for details.