ADDR=0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb
curl "https://api.arcus.xyz/v1/apiKeys?address=${ADDR}"import requests
r = requests.get(
"https://api.arcus.xyz/v1/apiKeys",
params={"address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"},
)
print(r.json())
const url = new URL("https://api.arcus.xyz/v1/apiKeys");
url.searchParams.set("address", "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb");
const res = await fetch(url);
console.log(await res.json());
const options = {method: 'GET'};
fetch('https://api.arcus.xyz/v1/apiKeys', 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://api.arcus.xyz/v1/apiKeys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.arcus.xyz/v1/apiKeys"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcus.xyz/v1/apiKeys")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcus.xyz/v1/apiKeys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"apiKeys": [
{
"apiKey": "<string>",
"address": "<string>",
"status": "ACTIVE",
"validUntil": 123,
"createdAt": 123,
"allSubaccounts": true,
"accountIndex": 4,
"apiWalletName": "<string>",
"permissions": [
"withdraw"
]
}
]
}{
"error": "Invalid request body",
"code": "GEO_RESTRICTED",
"errorSource": "Order",
"errorType": "Tick",
"rejectionReason": "POST_ONLY_WOULD_CROSS"
}{
"error": "rate limited",
"reason": "account_empty",
"retryAfterMs": 850,
"clientId": "my-order-42"
}{
"error": "Invalid request body",
"code": "GEO_RESTRICTED",
"errorSource": "Order",
"errorType": "Tick",
"rejectionReason": "POST_ONLY_WOULD_CROSS"
}Get API keys
Returns all API keys associated with the given Ethereum address.
ADDR=0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb
curl "https://api.arcus.xyz/v1/apiKeys?address=${ADDR}"import requests
r = requests.get(
"https://api.arcus.xyz/v1/apiKeys",
params={"address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"},
)
print(r.json())
const url = new URL("https://api.arcus.xyz/v1/apiKeys");
url.searchParams.set("address", "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb");
const res = await fetch(url);
console.log(await res.json());
const options = {method: 'GET'};
fetch('https://api.arcus.xyz/v1/apiKeys', 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://api.arcus.xyz/v1/apiKeys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.arcus.xyz/v1/apiKeys"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcus.xyz/v1/apiKeys")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcus.xyz/v1/apiKeys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"apiKeys": [
{
"apiKey": "<string>",
"address": "<string>",
"status": "ACTIVE",
"validUntil": 123,
"createdAt": 123,
"allSubaccounts": true,
"accountIndex": 4,
"apiWalletName": "<string>",
"permissions": [
"withdraw"
]
}
]
}{
"error": "Invalid request body",
"code": "GEO_RESTRICTED",
"errorSource": "Order",
"errorType": "Tick",
"rejectionReason": "POST_ONLY_WOULD_CROSS"
}{
"error": "rate limited",
"reason": "account_empty",
"retryAfterMs": 850,
"clientId": "my-order-42"
}{
"error": "Invalid request body",
"code": "GEO_RESTRICTED",
"errorSource": "Order",
"errorType": "Tick",
"rejectionReason": "POST_ONLY_WOULD_CROSS"
}accountIndex, the listing spans every subaccount of the address (plus any all-subaccounts keys). A single-subaccount key entry is tagged with the accountIndex it belongs to; an all-subaccounts key entry omits accountIndex and sets allSubaccounts: true — use that flag as the scope discriminator. Pass accountIndex to scope the listing to one single-subaccount partition. Because the response is all-or-nothing across subaccounts, a 200 is safe to treat as the complete set for the requested window — an unreadable subaccount surfaces as a 500 rather than a short list that would look like a revoked key.
Results are ordered newest-first by createdAt and capped at limit (default and max 1000). Narrow the set with limit / from / to; createdAt is epoch milliseconds, the same unit the bounds take, so a value read from one page is a valid bound for the next.Query Parameters
Master Ethereum address for this API key (must match address from POST /createApiKey for the same key). Required on REST for account-scoped reads and for place/cancel. Invalid hex → 400; mismatch with key → 403.
20-byte EVM address as hex: optional 0x or 0X prefix and exactly 40 hexadecimal digits. API responses normalize to lowercase a–f after 0x.
^(0x|0X)?[0-9a-fA-F]{40}$Subaccount index (0–9) to scope the listing to. Omit it to list the keys of every subaccount — unlike other account-scoped reads, this parameter has no default, and an omitted value is not the same as accountIndex=0. A single-subaccount key entry carries its own accountIndex; an all-subaccounts key entry omits accountIndex and sets allSubaccounts: true instead. Group an unscoped listing client-side on allSubaccounts first, then accountIndex — no need for one request per subaccount. Non-integer or out-of-range values → 400 (never a silent fallback to 0).
0 <= x <= 9Maximum number of API keys to return. Default and maximum are both 1000; requests above the maximum are silently clamped. The window is applied before this cap, so a windowed page still carries up to limit keys. When no accountIndex is given the cap is global across every subaccount — the page is the limit most recently created keys the address holds.
1 <= x <= 1000Start of the time window, filtering on createdAt (epoch milliseconds, inclusive) — the same unit and field the response reports, so a createdAt read from one page is a valid bound for the next with no conversion. Omit (or pass 0) for an open-ended start.
Note: unlike the time-series list endpoints (orders, fills, …) whose bounds are microseconds, this endpoint's timestamps are milliseconds; bounds match that unit.
x >= 01785801600123
End of the time window, filtering on createdAt (epoch milliseconds, inclusive) — the same unit and field the response reports, so a createdAt read from one page is a valid bound for the next with no conversion. Omit (or pass 0) for an open-ended end.
x >= 01785801699001
Response
List of API keys — for every subaccount of the address, or for the single subaccount named by accountIndex. Ordered newest-first by createdAt and capped at limit.
Show child attributes
Show child attributes
Was this page helpful?