Skip to main content
GET
/
v1
/
api-meta
/
userPreferences
Get user preferences
curl --request GET \
  --url https://api.testnet.arcus.xyz/v1/api-meta/userPreferences
{
  "address": "<string>",
  "preferences": {},
  "schemaVersions": {}
}
Returns the full preference bag for address. Public — no X-API-Key and no signature required. An address with no stored preferences returns { "address": addr, "preferences": {}, "schemaVersions": {...} }; the backend does not synthesize defaults. Each value is the JSON form of the registered type for that key. See UserPreferenceValue.

Query Parameters

​
address
string
required

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.

Pattern: ^(0x|0X)?[0-9a-fA-F]{40}$

Response

Preference bag for the requested address (possibly empty).

​
address
string
required

Canonical lowercase 0x+40 form of the queried address.

Pattern: ^(0x|0X)?[0-9a-fA-F]{40}$
​
preferences
object
required

Map from UserPreferenceKey to UserPreferenceValue.

​
schemaVersions
object
required

Per-key schema version. Clients may ignore this; the field exists so future breaking type changes for a key can be detected by pinned clients without rewriting old rows.