Struct RestClient 

pub struct RestClient { /* private fields */ }

REST client for the Coinbase Advanced Trade API.

Implementations

impl RestClient

pub fn builder() -> RestClientBuilder

Create a new client builder.

pub fn has_credentials(&self) -> bool

Check if the client has credentials configured.

pub fn accounts(&self) -> AccountsApi<'_>

Access the Accounts API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let accounts = client.accounts().list_all().await?;

pub fn products(&self) -> ProductsApi<'_>

Access the Products API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let products = client.products().list_all().await?;

pub fn public(&self) -> PublicApi<'_>

Access the Public API.

These endpoints do not require authentication.

Example

let client = RestClient::builder().build()?;

let time = client.public().get_time().await?;
println!("Server time: {}", time.iso);

pub fn orders(&self) -> OrdersApi<'_>

Access the Orders API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let orders = client.orders().list_all().await?;

pub fn fees(&self) -> FeesApi<'_>

Access the Fees API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let summary = client.fees().get_transaction_summary().await?;
println!("Fee tier: {}", summary.fee_tier.pricing_tier);

pub fn data(&self) -> DataApi<'_>

Access the Data API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let permissions = client.data().get_key_permissions().await?;
println!("Can trade: {}", permissions.can_trade);

pub fn payment_methods(&self) -> PaymentMethodsApi<'_>

Access the Payment Methods API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let payment_methods = client.payment_methods().list().await?;
for pm in payment_methods {
    println!("{}: {}", pm.name, pm.payment_type);
}

pub fn portfolios(&self) -> PortfoliosApi<'_>

Access the Portfolios API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let portfolios = client.portfolios().list().await?;
for portfolio in portfolios {
    println!("{}: {}", portfolio.uuid, portfolio.name);
}

pub fn convert(&self) -> ConvertApi<'_>

Access the Convert API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let request = CreateConvertQuoteRequest::new("USD-account", "USDC-account", "100.00");
let quote = client.convert().create_quote(request).await?;

pub fn perpetuals(&self) -> PerpetualsApi<'_>

Access the Perpetuals (INTX) API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let response = client.perpetuals().list_positions("portfolio-uuid").await?;

pub fn futures(&self) -> FuturesApi<'_>

Access the Futures (CFM) API.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let positions = client.futures().list_positions().await?;

pub fn base_url(&self) -> &str

Get the base URL.

pub async fn get<T: DeserializeOwned>(&self, endpoint: &str) -> Result<T>

Make a GET request to an authenticated endpoint.

pub async fn get_with_query<Q: Serialize, T: DeserializeOwned>( &self, endpoint: &str, query: &Q, ) -> Result<T>

Make a GET request with query parameters.

pub async fn post<B: Serialize, T: DeserializeOwned>( &self, endpoint: &str, body: &B, ) -> Result<T>

Make a POST request.

pub async fn put<B: Serialize, T: DeserializeOwned>( &self, endpoint: &str, body: &B, ) -> Result<T>

Make a PUT request.

pub async fn delete<T: DeserializeOwned>(&self, endpoint: &str) -> Result<T>

Make a DELETE request.

pub async fn public_get<T: DeserializeOwned>(&self, endpoint: &str) -> Result<T>

Make a public (unauthenticated) GET request.

pub async fn public_get_with_query<Q: Serialize, T: DeserializeOwned>( &self, endpoint: &str, query: &Q, ) -> Result<T>

Make a public GET request with query parameters.

impl RestClient

pub fn market_order(&self) -> MarketOrderBuilder<'_>

Create a market order builder.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

// Buy $100 of BTC
let response = client.market_order()
    .buy("BTC-USD")
    .quote_size("100.00")
    .send()
    .await?;

// Sell 0.001 BTC
let response = client.market_order()
    .sell("BTC-USD")
    .base_size("0.001")
    .send()
    .await?;

pub fn limit_order_gtc(&self) -> LimitOrderGtcBuilder<'_>

Create a limit order (GTC) builder.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let response = client.limit_order_gtc()
    .buy("BTC-USD")
    .base_size("0.001")
    .limit_price("50000.00")
    .post_only(true)
    .send()
    .await?;

pub fn limit_order_gtd(&self) -> LimitOrderGtdBuilder<'_>

Create a limit order (GTD) builder.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let response = client.limit_order_gtd()
    .buy("BTC-USD")
    .base_size("0.001")
    .limit_price("50000.00")
    .end_time("2024-12-31T23:59:59Z")
    .send()
    .await?;

pub fn stop_limit_order_gtc(&self) -> StopLimitOrderGtcBuilder<'_>

Create a stop-limit order (GTC) builder.

Example

let client = RestClient::builder()
    .credentials(Credentials::from_env()?)
    .build()?;

let response = client.stop_limit_order_gtc()
    .sell("BTC-USD")
    .base_size("0.001")
    .limit_price("49000.00")
    .stop_price("50000.00")
    .stop_direction(StopDirection::StopDirectionStopDown)
    .send()
    .await?;

Trait Implementations

impl Clone for RestClient

fn clone(&self) -> RestClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.