API Key Types
ApiKeyCreds
API key credentials for authenticating with the CLOB.The API key
The API secret for signing requests
The passphrase associated with the API key
Example
ApiKeyRaw
Raw API key response format.The API key
The API secret
The passphrase
ReadonlyApiKeyResponse
Response containing a read-only API key.The read-only API key
ApiKeysResponse
Response containing multiple API key credentials.Array of API key credentials
BuilderApiKey
Builder API key credentials.Builder API key
Builder API secret
Builder API passphrase
BuilderApiKeyResponse
Response containing builder API key information.Builder API key
Timestamp when the key was created
Timestamp when the key was revoked (if applicable)
Header Types
SimpleHeaders
Basic header type for HTTP requests.L1PolyHeader
Layer 1 authentication headers using EIP712 signature verification.Ethereum address of the signer
EIP712 signature
Timestamp of the request
Nonce for the request
Example
L2PolyHeader
Layer 2 authentication headers using API key verification.Ethereum address of the API key owner
HMAC signature of the request
Timestamp of the request
API key
API key passphrase
Example
L2WithBuilderHeader
Layer 2 headers with additional builder API key authentication.Builder API key
Builder timestamp
Builder API passphrase
Builder HMAC signature
L2HeaderArgs
Arguments for constructing Layer 2 headers.HTTP method (GET, POST, DELETE, etc.)
API endpoint path
Request body as a string (for POST/PUT requests)
Example
Signature Types
SignatureType
Enumeration of supported signature types.ECDSA EIP712 signatures signed by Externally Owned Accounts
EIP712 signatures signed by EOAs that own Polymarket Proxy wallets
EIP712 signatures signed by EOAs that own Polymarket Gnosis safes
Example
EIP712 Types
EIP712TypedData
Complete EIP712 typed data structure for signing.Type definitions for the typed data
Domain separator information
The message to be signed
The primary type being signed
EIP712Types
Type definitions for EIP712 typed data.EIP712Parameter
Field definition for EIP712 types.Field name
Field type (e.g., “string”, “uint256”, “address”)
EIP712Object
Generic EIP712 object.MessageTypes
Message type definitions including EIP712Domain.Required EIP712Domain type definition
MessageTypeProperty
Property definition for message types.Property name
Property type
User Status Types
BanStatus
User ban status information.Whether the user can only close existing positions (cannot open new ones)