Skip to main content

Crate ndaxrs

Crate ndaxrs 

Source
Expand description

§ndaxrs

A Rust client library for the NDAX cryptocurrency exchange API.

This crate provides a WebSocket-based client for interacting with the NDAX exchange API, supporting both public and authenticated endpoints.

§Quick Start

use std::time::Duration;

use ndaxrs::{NdaxConfig, NdaxCredentials, Result};

fn example() -> Result<()> {
  // Load credentials from environment variables
  let creds = NdaxCredentials::from_env()?;

  // Build config with builder pattern
  let config = NdaxConfig::builder()
    .credentials(creds)
    .timeout(Duration::from_secs(30))
    .build()?;

  // Or use defaults (no auth, default timeout) for public endpoints
  let public_config = NdaxConfig::builder().build()?;
  Ok(())
}

Re-exports§

pub use messages::ActionType;
pub use messages::GenericResponse;
pub use messages::NdaxFrame;
pub use messages::NdaxMessageType;
pub use messages::OrderState;
pub use messages::OrderType;
pub use messages::Side;
pub use messages::TimeInForce;
pub use ws::NdaxWsAPI;
pub use ws::NdaxWsConfig;

Modules§

messages
NDAX WebSocket message types.
ws
WebSocket client for the NDAX API.

Structs§

NdaxConfig
Configuration for the NDAX client.
NdaxConfigBuilder
Builder for NdaxConfig.
NdaxCredentials
Credentials for authenticating with the NDAX API.

Enums§

Error
Error type for ndaxrs operations.

Constants§

DEFAULT_TIMEOUT
Default timeout for API requests.
DEFAULT_WS_URL
Default WebSocket URL for the NDAX API.

Type Aliases§

Result
Result type alias for ndaxrs operations.