Skip to main content

Python SDK for the Flexemarkets API

Project description

fm-sdk-python

Python SDK for the Flexemarkets API.

Requirements

  • Python 3.11+

Install

python3.11 -m pip install .

Or install dependencies directly:

python3.11 -m pip install httpx websockets

Configuration

The SDK loads credentials and endpoint from these sources (highest priority first):

  1. Arguments passed to Flexemarkets.connect()
  2. Files ~/.fm/credential and ~/.fm/endpoint (Java .properties format)
  3. Environment variable FM_API_URL (defaults to https://api.flexemarkets.com)

Credential file

Create ~/.fm/credential:

account=myaccount
email=user@example.com
password=secret

Or use a bearer token:

token=eyJhbGciOiJIUzI1NiJ9...

Endpoint file

Create ~/.fm/endpoint:

endpoint=https://api.flexemarkets.com/api/marketplaces/123

SDK usage

from fm import Flexemarkets, OrderBooks, MarketplaceTrades

# Connect
fm = Flexemarkets.connect(
    credential="~/.fm/credential",
    endpoint="https://api.flexemarkets.com/api/marketplaces/123",
    client_description="my-bot",
)

# REST API
marketplace_id = fm.endpoint_marketplace_id
markets = fm.markets(marketplace_id)
session = fm.session(marketplace_id)
holdings = fm.holdings(marketplace_id)

# Submit orders
order = fm.submit_limit(marketplace_id, market_id, "BUY", units=1, price=950)
fm.submit_cancel(marketplace_id, market_id, order.id)

# WebSocket events
import queue

q = queue.Queue(maxsize=1000)
fm.listen(marketplace_id, q)

books = OrderBooks(markets)
trades = MarketplaceTrades(markets)

while True:
    event = q.get()
    match event:
        case list() as orders:
            books.update(orders)
            trades.update(orders)
        case Session() as s:
            print(s.state)
        case Holding() as h:
            print(h.cash)

fm.close()

The client also works as a context manager:

with Flexemarkets.connect(credential, endpoint, "my-bot") as fm:
    ...

Applications

ticker

Live terminal display of order book best bid/ask, spread, and recent trade prices.

python3.11 ticker.py -C ~/.fm/credential -E https://api.flexemarkets.com/api/marketplaces/123

Options:

Flag Description
-C, --credential Credential file path or bearer token
-E, --endpoint Marketplace endpoint file path or URL

Output:

fm-ticker                                              OPEN

  Symbol     Bid     Ask  Spread   Last trades
  ------  ------  ------  ------   -----------
    AAPL  $ 9.50  $10.50  $ 1.00   $9.50  $10.00
     IBM  $ 4.00  $ 5.00  $ 1.00   $4.50

The display refreshes on each order book update. Press Ctrl-C to stop.

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

fm_sdk-0.0.4.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

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

fm_sdk-0.0.4-py3-none-any.whl (28.1 kB view details)

Uploaded Python 3

File details

Details for the file fm_sdk-0.0.4.tar.gz.

File metadata

  • Download URL: fm_sdk-0.0.4.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fm_sdk-0.0.4.tar.gz
Algorithm Hash digest
SHA256 6f744f28a970598b10bbf1b7017fdf31390ab9910f8d97a12a6db26ce94195be
MD5 ce9fb615560fe1730a01201b17df1d34
BLAKE2b-256 aa4e275e9063128bceb40d818a40ca4db006c44004f9aee6bf5e9214e625c8d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for fm_sdk-0.0.4.tar.gz:

Publisher: release.yml on flexemarkets/fm-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fm_sdk-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: fm_sdk-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 28.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fm_sdk-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 76a32f57b9d6ccdade071eec73c4b9c22bca37f77d274b62388c8c24a44e4f3f
MD5 61c7e53e71766ce0caeb806c24715336
BLAKE2b-256 02809379d41cd8aacb5ea8b204af6961f1a68cdfd3c6f71ad33097e9dfd88c5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for fm_sdk-0.0.4-py3-none-any.whl:

Publisher: release.yml on flexemarkets/fm-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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