Refresh balance & allowance

xo-orderbook-client-rs

// Requires an authenticated client. Forces a fresh chain read.
use xo_orderbook_client::orderbook::types::request::UpdateBalanceAllowanceRequest;

let resp = client
    .update_balance_allowance(UpdateBalanceAllowanceRequest::default())
    .await?;

const options = {method: 'GET', headers: {XO_API_KEY: '<api-key>'}};

fetch('https://orderbooks.xo.market/balance-allowance/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://orderbooks.xo.market/balance-allowance/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "XO_API_KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://orderbooks.xo.market/balance-allowance/update"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("XO_API_KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://orderbooks.xo.market/balance-allowance/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["XO_API_KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "balance": "12345678",
  "allowance": "10000000",
  "smart_account": "CAFE000000000000000000000000000000000A11"
}

GET

balance-allowance

update

xo-orderbook-client-rs

// Requires an authenticated client. Forces a fresh chain read.
use xo_orderbook_client::orderbook::types::request::UpdateBalanceAllowanceRequest;

let resp = client
    .update_balance_allowance(UpdateBalanceAllowanceRequest::default())
    .await?;

const options = {method: 'GET', headers: {XO_API_KEY: '<api-key>'}};

fetch('https://orderbooks.xo.market/balance-allowance/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://orderbooks.xo.market/balance-allowance/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "XO_API_KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://orderbooks.xo.market/balance-allowance/update"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("XO_API_KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://orderbooks.xo.market/balance-allowance/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["XO_API_KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "balance": "12345678",
  "allowance": "10000000",
  "smart_account": "CAFE000000000000000000000000000000000A11"
}

Authorizations

XO_API_KEY

string

header

required

L2 HMAC request signature. See Authentication.

Query Parameters

address

string

required

asset_type

enum<string>

Available options:

COLLATERAL,

CONDITIONAL

token_id

string

Response

balance

string

required

USDC cash balance in micro-units, decimal string. (XO does not currently honour asset_type=CONDITIONAL — see endpoint description.)

allowance

string

required

Available cash after open-order reservations, decimal-string micro-USDC. balance - allowance is the amount earmarked against resting BUY orders.

smart_account

string | null

User's smart-account address as hex without 0x prefix (e.g. "CAFE000000000000000000000000000000000A11"). null for plain EOA users with no smart account. XO-only field — not part of the canonical CLOB wire contract.

Overview

Authentication

Market Data

Markets

Trade

Account

WebSockets

Market Data

Markets

Trade

Account

Authentication

Refresh balance & allowance

Authorizations

Query Parameters

Response