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.1.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.1-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ironbeam-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 43f67187b3b61d8af5d32a872ea66a4eb600a21b1e7c449cbf77235283f202d2
MD5 098a5771519bbf7e9efce364c6ab11c3
BLAKE2b-256 8b944f8bd0b50076c32a845777c4deaf5b28ee378bb7fca28803adbd6912f17c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ironbeam-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0e985a48b80d5f8d695b1a4a18864cc4b9fceed6f11fee8585aaabe93880faf9
MD5 aceff1f54b605f5198bebc773393d4bd
BLAKE2b-256 56c061f25f1c7b6ef0eafacd23bb081c83307fbc8a1bdcf28cea3dc9e252f4af

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