Skip to main content

River Markets Python SDK

Python SDK for the River Markets API.

Installation

pip install rivermarkets

Authentication

The SDK authenticates with Ed25519 request signing. Create an API key in Settings → API Keys; you'll get a Key ID (UUID) and a base64-encoded private key (shown once at creation). Pass both to the client — every request is signed transparently via X-River-Key-Id, X-River-Timestamp, and X-River-Signature headers.

Usage

from rivermarkets import RiverMarkets

client = RiverMarkets(
    key_id="YOUR_KEY_ID",
    private_key="YOUR_BASE64_PRIVATE_KEY",
)

# Search markets
results = client.markets.search_markets(q="bitcoin")

# Place an order
order = client.orders.create_order(
    subaccount_id="...",
    river_id=4552150,
    order_type="LIMIT",
    time_in_force="GTC",
    buy_flag=True,
    price=0.50,
    qty=10,
)

# Cancel an order
client.orders.cancel_order(order_id="...")

Async

from rivermarkets import AsyncRiverMarkets

client = AsyncRiverMarkets(
    key_id="YOUR_KEY_ID",
    private_key="YOUR_BASE64_PRIVATE_KEY",
)
results = await client.markets.search_markets(q="bitcoin")

Local fee calculations

The client fetches each market's live fee schedule once and caches it for the lifetime of that client. You can also warm several schedules with one request:

from rivermarkets import RiverMarkets

client = RiverMarkets(
    key_id="YOUR_KEY_ID",
    private_key="YOUR_BASE64_PRIVATE_KEY",
)

river_id = 4552150
qty = 10
price = 0.50

client.prefetch_fee_schedules([river_id])

taker_fee = client.compute_fee(
    river_id=river_id,
    qty=qty,
    price=price,
    is_maker=False,
)
maker_fee = client.compute_fee(
    river_id=river_id,
    qty=qty,
    price=price,
    is_maker=True,
)

# Normalize quoted prices to include the per-contract taker fee.
buy_all_in = price + taker_fee / qty
sell_net = price - taker_fee / qty

compute_fee makes no network request after the River ID is cached. Call clear_fee_schedule_cache(river_id) to force the next calculation to reload that schedule.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rivermarkets-0.11.0.tar.gz (59.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rivermarkets-0.11.0-py3-none-any.whl (112.4 kB view details)

Uploaded Python 3

File details

Details for the file rivermarkets-0.11.0.tar.gz.

File metadata

  • Download URL: rivermarkets-0.11.0.tar.gz
  • Upload date:
  • Size: 59.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for rivermarkets-0.11.0.tar.gz
Algorithm Hash digest
SHA256 376b1251d9ee70777aad77617797ed2cac8703e860b28b1895c520f9b9320522
MD5 5edbd27d4cae11072edb1dfdc9ce7e23
BLAKE2b-256 5dcc856ac0901e5ff9b5eca2227ace113b9c8279632142aad9e9a5032bd9d179

See more details on using hashes here.

File details

Details for the file rivermarkets-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: rivermarkets-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 112.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for rivermarkets-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb284e6761f7610ea777e7e4306738d455336e6bea562f3d7e9d86a188b1125a
MD5 8c3c6dbf788299da7b76c8b520a8017a
BLAKE2b-256 9159b5d4cd20967e1ce1836431d6afcf6bbc6518b9cfc60da79303e0a4091dfc

See more details on using hashes here.

Release history Release notifications | RSS feed

0.12.0

2 files

0.11.1

2 files

This release

0.11.0 This release

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page