Struct OkxSignedRequestBuilder 

pub struct OkxSignedRequestBuilder<'a> { /* private fields */ }

Builder for creating authenticated OKX API requests.

This builder encapsulates the common signing workflow:

1. Credential validation
2. ISO 8601 timestamp generation
3. Parameter signing with HMAC-SHA256
4. Authentication header injection
5. HTTP request execution

Example

let okx = Okx::new(ExchangeConfig::default())?;

let data = okx.signed_request("/api/v5/account/balance")
    .param("instId", "BTC-USDT")
    .optional_param("limit", Some(100))
    .execute()
    .await?;

Implementations

impl<'a> OkxSignedRequestBuilder<'a>

pub fn new(okx: &'a Okx, endpoint: impl Into<String>) -> Self

Creates a new signed request builder.

Arguments

• okx - Reference to the OKX exchange instance
• endpoint - API endpoint path (e.g., “/api/v5/account/balance”)

Example

let okx = Okx::new(ExchangeConfig::default()).unwrap();
let builder = OkxSignedRequestBuilder::new(&okx, "/api/v5/account/balance");

pub fn method(self, method: HttpMethod) -> Self

Sets the HTTP method for the request.

Default is GET.

Arguments

• method - The HTTP method to use

Example

let okx = Okx::new(ExchangeConfig::default())?;
let data = okx.signed_request("/api/v5/trade/order")
    .method(HttpMethod::Post)
    .param("instId", "BTC-USDT")
    .execute()
    .await?;

pub fn param(self, key: impl Into<String>, value: impl ToString) -> Self

Adds a required parameter.

Arguments

• key - Parameter name
• value - Parameter value (will be converted to string)

Example

let okx = Okx::new(ExchangeConfig::default())?;
let data = okx.signed_request("/api/v5/trade/orders-history")
    .param("instId", "BTC-USDT")
    .param("limit", 100)
    .execute()
    .await?;

pub fn optional_param<T: ToString>( self, key: impl Into<String>, value: Option<T>, ) -> Self

Adds an optional parameter (only if value is Some).

Arguments

• key - Parameter name
• value - Optional parameter value

Example

let okx = Okx::new(ExchangeConfig::default())?;
let since: Option<i64> = Some(1234567890000);
let limit: Option<u32> = None;

let data = okx.signed_request("/api/v5/trade/orders-history")
    .param("instId", "BTC-USDT")
    .optional_param("after", since)
    .optional_param("limit", limit)  // Won't be added since it's None
    .execute()
    .await?;

pub fn params(self, params: BTreeMap<String, String>) -> Self

Adds multiple parameters from a BTreeMap.

Arguments

• params - Map of parameter key-value pairs

Example

let okx = Okx::new(ExchangeConfig::default())?;
let mut params = BTreeMap::new();
params.insert("instId".to_string(), "BTC-USDT".to_string());
params.insert("tdMode".to_string(), "cash".to_string());

let data = okx.signed_request("/api/v5/trade/order")
    .params(params)
    .execute()
    .await?;

pub fn body(self, body: Value) -> Self

Sets the request body for POST/DELETE requests.

Arguments

• body - JSON value to use as request body

Example

let okx = Okx::new(ExchangeConfig::default())?;
let body = json!({
    "instId": "BTC-USDT",
    "tdMode": "cash",
    "side": "buy"
});

let data = okx.signed_request("/api/v5/trade/order")
    .method(ccxt_exchanges::okx::signed_request::HttpMethod::Post)
    .body(body)
    .execute()
    .await?;

pub async fn execute(self) -> Result<Value>

Executes the signed request and returns the response.

This method:

1. Validates that credentials are configured
2. Gets the current ISO 8601 timestamp
3. Signs the request with HMAC-SHA256
4. Adds authentication headers
5. Executes the HTTP request

Returns

Returns the raw serde_json::Value response for further parsing.

Errors

• Returns authentication error if credentials are missing
• Returns network error if the request fails
• Returns parse error if response parsing fails

Example

let okx = Okx::new(ExchangeConfig::default())?;
let data = okx.signed_request("/api/v5/account/balance")
    .execute()
    .await?;
println!("Response: {:?}", data);