Skip to main content

Add your description here

Project description

Ironbeam

The provides an unofficial python wrapper around Ironbeam's API for futures.

This is a work in progress.

Key features include:

  • Account Information
  • Orders, both Live orders on your Ironbeam account or use a Demo account that can be created with the API.
  • Historical Data
  • Streaming Data.

Documentation

Make sure you are familiar with the Ironbeam Official API Docs. There are some typos and stuff with the docs so it took a little detective work to figure this out. If you see something that doesn't look in this library it might be because the docs are wrong.

Roadmap

  • Async support
  • Documentation
  • Community

Requirements

  • httpx = '>=0.28.1'
  • pandas = '>=2.2.3'
  • pydantic = '>=2.10.4'

Installation

To install the latest stable version of the package from PyPi:

pip install -U ironbeam

Usage

# Basic usage
import ironbeam as ib

client = ib.Ironbeam(apikey='<API KEY>')
client.authorize(username='<USERNAME>')
print(client.token)

# Use client...

client.logout()

# Context manager usage
with ib.Ironbeam(apikey='<API KEY>') as client:
  client.authorize(username='<USERNAME>')

Contact

Feel free to contact us with any questions.

Project details


Download files

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

Source Distribution

ironbeam-0.1.2.tar.gz (45.1 kB view details)

Uploaded Source

Built Distribution

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

ironbeam-0.1.2-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file ironbeam-0.1.2.tar.gz.

File metadata

  • Download URL: ironbeam-0.1.2.tar.gz
  • Upload date:
  • Size: 45.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.22

File hashes

Hashes for ironbeam-0.1.2.tar.gz
Algorithm Hash digest
SHA256 015cda4dffa2e17f02d532849140b6d6feb4fac389072257de2b3ad8da681bd9
MD5 5f551a4a96dc6984bfad76e1763dbb7e
BLAKE2b-256 6503dec0f6720fc74420421c938fcb0b900ad0d96a117cf73edc0bece1885efa

See more details on using hashes here.

File details

Details for the file ironbeam-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: ironbeam-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.22

File hashes

Hashes for ironbeam-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cfe11e8e05f3a786e9c0456978c69c652c49ae3e0e2b29df081c344159154f4f
MD5 bc28ae771aa19a4b8edcf1344e1ba7d8
BLAKE2b-256 aeb34d3eb5fdcde4186844fc24ba6c4b75399911e51ea71057f5fbd93a89d502

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page