HTTP Client

The HTTP client module provides the base functionality for making HTTP requests to the BingX API.

class bingx_py.http_client.BingXHttpClient(api_key, api_secret, base_url, cache=None, default_cache_ttl=300)

Bases: HttpClient

HTTP client for interacting with the BingX API.

Parameters:

• api_key (str)

• api_secret (str)

• base_url (str)

• cache (BaseCache | BaseAsyncCache | None)

• default_cache_ttl (int)

async async_delete(endpoint, params=None, headers=None)

Perform an asynchronous DELETE request.

Parameters:

• endpoint (str) – The API endpoint.

• params (Optional[Dict[str, Any]]) – The request parameters.

• headers (Optional[Dict[str, str]]) – The request headers.

Returns:

The response data.

Return type:

Dict[str, Any]

async async_get(endpoint, params=None, headers=None, use_cache=False, unique_cache_attribute=None)

Perform an asynchronous GET request.

Parameters:

• endpoint (str) – The API endpoint.

• params (Optional[Dict[str, Any]]) – The request parameters.

• headers (Optional[Dict[str, str]]) – The request headers.

• use_cache (bool) – Whether to use caching for the request. Defaults to False.

• unique_cache_attribute (Optional[str]) – An optional unique attribute for the cache key.

Returns:

The response data.

Return type:

Dict[str, Any]

async async_post(endpoint, params=None, headers=None)

Perform an asynchronous POST request.

Parameters:

• endpoint (str) – The API endpoint.

• params (Optional[Dict[str, Any]]) – The request parameters.

• headers (Optional[Dict[str, str]]) – The request headers.

Returns:

The response data.

Return type:

Dict[str, Any]

async async_put(endpoint, params=None, headers=None)

Perform an asynchronous PUT request.

Parameters:

• endpoint (str) – The API endpoint.

• params (Optional[Dict[str, Any]]) – The request parameters.

• headers (Optional[Dict[str, str]]) – The request headers.

Returns:

The response data.

Return type:

Dict[str, Any]

delete(endpoint, params=None, headers=None)

Perform a synchronous DELETE request.

Parameters:

• endpoint (str) – The API endpoint.

• params (Optional[Dict[str, Any]]) – The request parameters.

• headers (Optional[Dict[str, str]]) – The request headers.

Returns:

The response data.

Return type:

Dict[str, Any]

get(endpoint, params=None, headers=None, use_cache=False, unique_cache_attribute=None)

Perform a synchronous GET request.

Parameters:

• endpoint (str) – The API endpoint.

• params (Optional[Dict[str, Any]]) – The request parameters.

• headers (Optional[Dict[str, str]]) – The request headers.

• use_cache (bool) – Whether to use caching for the request. Defaults to False.

• unique_cache_attribute (Optional[str]) – An optional unique attribute for the cache key.

Returns:

The response data.

Return type:

Dict[str, Any]

post(endpoint, params=None, headers=None)

Perform a synchronous POST request.

Parameters:

• endpoint (str) – The API endpoint.

• params (Optional[Dict[str, Any]]) – The request parameters.

• headers (Optional[Dict[str, str]]) – The request headers.

Returns:

The response data.

Return type:

Dict[str, Any]

put(endpoint, params=None, headers=None)

Perform a synchronous PUT request.

Parameters:

• endpoint (str) – The API endpoint.

• params (Optional[Dict[str, Any]]) – The request parameters.

• headers (Optional[Dict[str, str]]) – The request headers.

Returns:

The response data.

Return type:

Dict[str, Any]

save_convert(data, pydantic_model)

Convert response data to a specified Pydantic model.

Parameters:

• data (Dict[str, Any]) – The data to be converted.

• pydantic_model (Type[BaseModel]) – The Pydantic model class for conversion.

Returns:

An instance of the provided Pydantic model.

Return type:

Any

Raises:

ConversionError – If conversion to the Pydantic model fails due to validation errors.

class bingx_py.http_client.HttpClient(base_url, cache=None, default_cache_ttl=300)

Bases: ABC

Base class for HTTP clients with caching support.

Parameters:

• base_url (str)

• cache (BaseCache | BaseAsyncCache | None)

• default_cache_ttl (int)

close()

Close the synchronous HTTP session.

Return type:

None

async close_async()

Close the asynchronous HTTP session.

Return type:

None

connect()

Initialize the synchronous HTTP session.

Returns:

None

Return type:

None

async connect_async()

Initialize the asynchronous HTTP session.

Return type:

None