lukka-api 0.1.6

Python client for Lukka cryptocurrency data API

Lukka API Python Client

A Python library for retrieving cryptocurrency data from the Lukka API. Supports pricing sources, historical prices (minute-level and daily), latest prices, and multiple output formats (JSON, CSV, Parquet).

Requirements

• Lukka API credentials (Sign up here)

Installation

Install from source

# PyPI
pip install lukka-api
pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ lukka-api

⚙️ Configuration

Authentication (Required)

The library supports three methods for providing credentials, in order of priority:

1. Explicit Parameters (Recommended for Production)

from lukka_api import LukkaPrices

prices = LukkaPrices(
    username="your_username",
    password="your_password"
)

2. Environment Variables (Recommended for 12-Factor Apps)

# Set in shell or via container orchestration
export username='your_username'
export password='your_password'

from lukka_api import LukkaPrices

# Credentials loaded from environment automatically
prices = LukkaPrices()

3. .env File (Local Development)

Important: Create an .env file in your projects directory.

LUKKA_USERNAME=your_username
LUKKA_PASSWORD=your_password

from lukka_api import LukkaPrices

# Credentials loaded from .env file
prices = LukkaPrices()

Quick Start

Basic Usage

from lukka_api import LukkaSources, LukkaPrices
from datetime import datetime, timedelta

# Initialize with explicit credentials (recommended for production)
username = ''
password = ''
sources = LukkaSources(username=username, password=password)
prices = LukkaPrices(username=username, password=password)

# Or use environment variables / .env file
sources = LukkaSources()
prices = LukkaPrices()

# Get all available pricing sources
sources.get_sources()

# Get sources for specific pairs only
sources.get_sources(pair_codes=['XBT-USD', 'ETH-USD'])

# Get sources for specific pairs with data available from a start date
sources.get_sources(pair_codes=['XBT-USD', 'ETH-USD'], start_date="2021-01-01")

# Get detailed information for a specific source, including pair_codes.
sources.get_source_details(source_id=1000)

# Get last 30 days of historical prices (uses default date range)
prices.get_historical_price(pair_codes='XBT-USD')

# Get historical prices from specific date to now
prices.get_historical_price(pair_codes='XBT-USD', from_date="2025-11-01")

# Get historical prices from beginning up to specific date
prices.get_historical_price(pair_codes='XBT-USD', to_date="2025-11-21")

# Get historical prices for specific date range
prices.get_historical_price(pair_codes='XBT-USD', from_date="2025-11-01", to_date="2025-11-21")

# Get latest price within last hour (default lookback)
prices.get_latest_price(pair_codes='XBT-USD')