Skip to main content

Python client for the Falcon AI Polymarket external analytics API

Project description

falcon-polymarket

Python client for the Falcon AI Polymarket external API.

Install

pip install falcon-polymarket

Local development:

pip install -e packages/falcon-polymarket-python

Quick start

Set FALCON_API_KEY (from Developer Keys) or pass explicitly:

from falcon_polymarket import FalconPolymarketClient

with FalconPolymarketClient() as client:
    print(client.health())
    for market in client.iter_markets(status="active", limit=10):
        print(market["title"], market.get("yes_price"))
    board = client.get_leaderboard(limit=5, sort_by="total_realized_pnl")
    print(board)
    ticks = client.price_ticks("0x...", hours=1)
    print(len(ticks), "sub-minute ticks")

Staging:

client = FalconPolymarketClient(
    api_key="aif_...",
    base_url="https://api-test.falconai.bot/api/v1/external/polymarket",
)

Methods

  • health(), usage()
  • list_markets(), iter_markets(), get_market()event_slug filter on list
  • list_events(), get_event(), list_series(), get_series()
  • get_orderbook(), orderbook_history()include_levels for recent L2 rows
  • price_ticks() — sub-minute CLOB WebSocket ticks
  • list_trades(), get_trader(), get_trader_stats()
  • get_leaderboard(), get_copy_picks(), get_positions()
  • run_backtest()

See the API reference for parameters and tiers.

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

falcon_polymarket-0.1.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

falcon_polymarket-0.1.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: falcon_polymarket-0.1.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for falcon_polymarket-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d6af3f397bed32ee6d12634d3ba4554f5e28630da8bbedc1ab4094cded7919ed
MD5 1ddafba06d91e151aede05ad4602dc0a
BLAKE2b-256 d807b3189ddcac3b4867523d146f0e5aebc62aa206e0f345765c361b39919b20

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for falcon_polymarket-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8d2f547a1bc46940702ddae21412d0155297ca0786deaaa0a486385c0ad6a939
MD5 7c22cbf1b43f760e89494f8cd22c3878
BLAKE2b-256 35e864cd9b8d4094855dc9d10fec33fc312bc6a06096ba930f0eea0a5d880c74

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