hstrader 1.1.0

HsTrader SDK for Python

HsTrader SDK for Python

hstrader-sdk-py is the HsTrader SDK for Python.

The HsTrader SDK requires a minimum version of Python 3.7.

Installation

pip install hstrader

Documentation

You can find the latest documentation at the official HsTrader API documentation

Getting Started

Http Example

from hstrader import HsTrader


# Its recommended to use environment variables to store your credentials
CLIENT_ID = "<YOUR_CLIENT_ID>"
CLIENT_SECRET = "<YOUR_CLIENT_SECRET>"
URL = "<YOUR_BROKER_URL>"


# Create a new instance of HSTrader
client = HsTrader(CLIENT_ID, CLIENT_SECRET, URL)

try:

    # Get the EURUSD symbol
    eurusd = client.get_symbol("EURUSD")
    print(
        f"Symbol ID: {eurusd.id}, Name: {eurusd.symbol}, Last Bid: {eurusd.last_bid}, Last Ask: {eurusd.last_ask}"
    )

except Exception as e:
    print(e)

Websocket Example

from hstrader import HsTrader
from hstrader.models import Event, Tick


# Its recommended to use environment variables to store your credentials
CLIENT_ID = "<YOUR_CLIENT_ID>"
CLIENT_SECRET = "<YOUR_CLIENT_SECRET>"
URL = "<YOUR_BROKER_URL>"


# Create a new instance of HSTrader
client = HsTrader(CLIENT_ID, CLIENT_SECRET, URL)


# Create a callback function to handle market updates
@client.subscribe(Event.MARKET) # alternatively, you can use @client.subscribe("market")
def on_market(tick: Tick):  # this function will be called whenever a new market update is received
    print(
        f"Received tick for symbol {tick.symbol_id}: bid = {tick.bid} ask = {tick.ask}"
    )


# Start listening to real-time data
client.start()

For more examples, please refer to the examples directory.

Contributing

Contributions are welcome.
If you've found a bug within this project, please open an issue to discuss what you would like to change.
If it's an issue with the API, please open a topic at Contact Us.