This SDK encapuslates the openfeed proto objects and faciliates client connections to openfeed servers.
pip install openfeed
Requires Python 3.9 or newer.
import openfeed
# new client with credentials
of_client = openfeed.OpenfeedClient("username", "password")
# optional state handlers
of_client.on_error = lambda x: print("Error:", x)
of_client.on_connected = lambda x: print("Connected")
of_client.on_disconnected = lambda x: print("Disconnected")
# attach a global message handler
of_client.on_message = lambda x: print("Global Message:", x)
# sub to markets by symbol
def on_message(msg):
print("Market Data: ", msg)
of_client.add_symbol_subscription("AAPL", callback=on_message)
# sub to markets by exchange
of_client.add_exchange_subscription("NYSE", callback=on_message)
of_client.start()of-client: Connected
of-client: Market Data: subscriptionResponse
of-client: Market Data: marketSnapshot
of-client: Market Data: marketUpdate
of-client: Market Data: marketUpdate
By default the client connects to openfeed.aws.barchart.com. Pass a host name to connect to another server, or a full ws:// or wss:// URL to set the scheme and path (for example, for TLS or a proxy):
of_client = openfeed.OpenfeedClient("username", "password", server="demo.openfeed.barchart.com")
of_client = openfeed.OpenfeedClient("username", "password", server="wss://host:port/path")Openfeed supports many levels of subscription types.
of_client.add_exchange_subscription(["NYSE"], callback=on_message, subscription_type=["OHLC"]){
marketId: 5389879102616877808
symbol: "AAPL"
open {
price: 1205600
}
high {
price: 1205600
}
low {
price: 1205247
}
close {
price: 1205490
}
volume: 43635
priceVolume: 5259897.1422
numberTrades: 224
tradeDate: 20201116
transactionTime: 1605547921000000000
openStartTime: 1605547885850000000
closeEndTime: 1605547920964000000
}
Requires uv and protoc (brew install protobuf).
uv sync # create .venv and install deps
uv run python example.py -u USER -p PASS # run the example
./build.sh # regenerate protos and build dist/