Developer-friendly, idiomatic Python SDK for the forex-engine-sdk-python API.
Fx Oracle Service API: HTTP API for prices, enriched market data, positions, orders, collateral, stats, and websocket streaming used by FxOracleClient.
Note
Python version upgrade policy
Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with either pip or poetry package managers.
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install paxeer-network-forex-engine-sdk-pythonPoetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add paxeer-network-forex-engine-sdk-pythonYou can use this SDK in a Python shell with uv and the uvx command that comes with it like so:
uvx --from paxeer-network-forex-engine-sdk-python pythonIt's also possible to write a standalone Python script without needing to set up a whole project like so:
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
# "paxeer-network-forex-engine-sdk-python",
# ]
# ///
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
sdk = FxOracleServiceAPI(
# SDK arguments
)
# Rest of script here...Once that is saved to a file, you can run it with uv run script.py where
script.py can be replaced with the actual file name.
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
# Synchronous Example
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
with FxOracleServiceAPI() as fx_oracle_service_api:
res = fx_oracle_service_api.get_health()
# Handle response
print(res)The same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
async def main():
async with FxOracleServiceAPI() as fx_oracle_service_api:
res = await fx_oracle_service_api.get_health_async()
# Handle response
print(res)
asyncio.run(main())Available methods
- get_health - Service health
- get_prices - All current prices
- get_prices_symbol_ - Price for a symbol
- get_enriched - Prices with enriched market data
- get_enriched_symbol_ - Enriched data for a symbol
- get_market_data_symbol_ - Real-time market data for a symbol
- post_market_data_batch - Batch market data
- get_api_positions_open - Open positions
- get_api_positions_account_address_ - Positions by account
- get_api_positions_market_market_id_ - Positions by market
- get_api_orders_recent - Recent orders
- get_api_orders_account_address_ - Orders by account
- get_api_collateral_account_address_ - Collateral events for account
- get_api_stats_account_address_ - Account statistics
- get_api_leaderboard - Trader leaderboard
- get_api_stats_markets - Market stats
- get_api_stats_system - System metrics
- get_api_stats_summary - Dashboard summary
- get_ws - WebSocket upgrade for real-time price and enriched data
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
from paxeer_network_fx_oracle_service_api_python.utils import BackoffStrategy, RetryConfig
with FxOracleServiceAPI() as fx_oracle_service_api:
res = fx_oracle_service_api.get_health(,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle response
print(res)If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
from paxeer_network_fx_oracle_service_api_python.utils import BackoffStrategy, RetryConfig
with FxOracleServiceAPI(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as fx_oracle_service_api:
res = fx_oracle_service_api.get_health()
# Handle response
print(res)Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will raise a models.APIError exception, which has the following properties:
| Property | Type | Description |
|---|---|---|
.status_code |
int | The HTTP status code |
.message |
str | The error message |
.raw_response |
httpx.Response | The raw HTTP response |
.body |
str | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the get_health_async method may raise the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| models.APIError | 4XX, 5XX | */* |
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI, models
with FxOracleServiceAPI() as fx_oracle_service_api:
res = None
try:
res = fx_oracle_service_api.get_health()
# Handle response
print(res)
except models.APIError as e:
# handle exception
raise(e)The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
with FxOracleServiceAPI(
server_url="https://api.fx-oracle.example",
) as fx_oracle_service_api:
res = fx_oracle_service_api.get_health()
# Handle response
print(res)The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = FxOracleServiceAPI(client=http_client)or you could wrap the client with your own custom logic:
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
from paxeer_network_fx_oracle_service_api_python.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = FxOracleServiceAPI(async_client=CustomClient(httpx.AsyncClient()))The FxOracleServiceAPI class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
def main():
with FxOracleServiceAPI() as fx_oracle_service_api:
# Rest of application here...
# Or when using async:
async def amain():
async with FxOracleServiceAPI() as fx_oracle_service_api:
# Rest of application here...You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from paxeer_network_fx_oracle_service_api_python import FxOracleServiceAPI
import logging
logging.basicConfig(level=logging.DEBUG)
s = FxOracleServiceAPI(debug_logger=logging.getLogger("paxeer_network_fx_oracle_service_api_python"))forex-engine-sdk-python&utm_campaign=python)