Skip to main content

​
API Keys

API keys are the primary authentication mechanism for the PolySimulator API. Each key is tied to a user account, has configurable permissions, and can be revoked instantly.

​
Create a Key

curl -X POST https://api.polysimulator.com/v1/keys \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-trading-bot",
    "permissions": ["read", "trade"],
    "tier": "free"
  }'
Response (201 Created): 
{
  "id": 1,
  "key": "ps_live_kJ9mNx2pQrStUvWxYz01Ab3CdEfGhI4j",
  "key_prefix": "ps_live_kJ9mNx2p",
  "name": "my-trading-bot",
  "permissions": ["read", "trade"],
  "rate_limit_tier": "free",
  "created_at": "2026-02-06T12:00:00Z",
  "expires_at": null
}
The key field is shown exactly once. Store it securely — it cannot be retrieved again. Only the SHA-256 hash is stored in the database.

​
List Keys

Returns all keys for your account. Only prefixes are shown — never the full key. 
curl -H "X-API-Key: $API_KEY" https://api.polysimulator.com/v1/keys

[
  {
    "id": 1,
    "key_prefix": "ps_live_kJ9mNx2p",
    "name": "my-trading-bot",
    "permissions": ["read", "trade"],
    "rate_limit_tier": "free",
    "is_active": true,
    "created_at": "2026-02-06T12:00:00Z",
    "expires_at": null
  }
]

​
Revoke a Key

Permanently deactivates a key. This action cannot be undone. 
curl -X DELETE -H "X-API-Key: $API_KEY" \
  https://api.polysimulator.com/v1/keys/1

{
  "message": "Key revoked successfully"
}

​
Key Limits

ConstraintValue
Max keys per user5
Key formatps_live_<64 hex chars>
StorageSHA-256 hash only
ExpirationOptional expires_at field

​
Next Steps