xo-orderbook-client-rs
use alloy::signers::local::LocalSigner;
use xo_orderbook_client::orderbook::{Client, Config};
let signer = LocalSigner::from_bytes(&std::env::var("XO_PRIVATE_KEY")?.parse()?)?;
let client = Client::new("https://orderbooks.xo.market", Config::default())?;
let creds = client.create_api_key(&signer).await?;
// creds: { api_key (UUID), secret (base64 HMAC), passphrase }
// Store all three — secret + passphrase are not returned again.
// For typical use, prefer `create_or_derive_api_key` — it idempotently
// returns existing creds if a key already exists for this wallet:
let creds = client.create_or_derive_api_key(&signer).await?;
curl --request POST \
--url https://orderbooks.xo.market/auth/api-key \
--header 'XO_ADDRESS: <api-key>'import requests
url = "https://orderbooks.xo.market/auth/api-key"
headers = {"XO_ADDRESS": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {XO_ADDRESS: '<api-key>'}};
fetch('https://orderbooks.xo.market/auth/api-key', 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/auth/api-key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"XO_ADDRESS: <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/auth/api-key"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("XO_ADDRESS", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://orderbooks.xo.market/auth/api-key")
.header("XO_ADDRESS", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://orderbooks.xo.market/auth/api-key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["XO_ADDRESS"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiKey": "7a3f9c1d-8b2e-4a5c-9d1e-2f3a4b5c6d7e",
"secret": "dGhpcy1pcy1hbi1leGFtcGxlLWhtYWMtc2VjcmV0LWtleS1iYXNlNjQ=",
"passphrase": "9f3a2b1c4d5e6f708192a3b4c5d6e7f8"
}Authentication
Create API key
Mint a new API key for the wallet that signed the L1 ClobAuth
headers. Caller is rate-limited to MAX_KEYS_PER_USER total
keys; further calls return 400 "api key limit reached".
POST
/
auth
/
api-key
xo-orderbook-client-rs
use alloy::signers::local::LocalSigner;
use xo_orderbook_client::orderbook::{Client, Config};
let signer = LocalSigner::from_bytes(&std::env::var("XO_PRIVATE_KEY")?.parse()?)?;
let client = Client::new("https://orderbooks.xo.market", Config::default())?;
let creds = client.create_api_key(&signer).await?;
// creds: { api_key (UUID), secret (base64 HMAC), passphrase }
// Store all three — secret + passphrase are not returned again.
// For typical use, prefer `create_or_derive_api_key` — it idempotently
// returns existing creds if a key already exists for this wallet:
let creds = client.create_or_derive_api_key(&signer).await?;
curl --request POST \
--url https://orderbooks.xo.market/auth/api-key \
--header 'XO_ADDRESS: <api-key>'import requests
url = "https://orderbooks.xo.market/auth/api-key"
headers = {"XO_ADDRESS": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {XO_ADDRESS: '<api-key>'}};
fetch('https://orderbooks.xo.market/auth/api-key', 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/auth/api-key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"XO_ADDRESS: <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/auth/api-key"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("XO_ADDRESS", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://orderbooks.xo.market/auth/api-key")
.header("XO_ADDRESS", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://orderbooks.xo.market/auth/api-key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["XO_ADDRESS"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiKey": "7a3f9c1d-8b2e-4a5c-9d1e-2f3a4b5c6d7e",
"secret": "dGhpcy1pcy1hbi1leGFtcGxlLWhtYWMtc2VjcmV0LWtleS1iYXNlNjQ=",
"passphrase": "9f3a2b1c4d5e6f708192a3b4c5d6e7f8"
}Authorizations
L1 ClobAuth EIP-712 wallet signature. See Authentication.
Response
OK
camelCase wire keys per CLOB SDK contract. The triplet is the full credential — the secret/passphrase are never returned again. Store them on receipt.
UUIDv4 — sent as POLY_API_KEY header on every L2 HMAC request.
Base64-encoded HMAC secret. Used to sign the request canonical string; never sent on the wire after creation.
Sent as POLY_PASSPHRASE header. Distinct from the secret —
both must match for the request to authenticate.