ClaimsService
Claim Daily Reward
Claim today's reward once for the authenticated root account. Requires a session JWT; API keys are not accepted. All reward assets are transferred together, and retries return the same claim.
Method
POST
Path
/v1/trading/daily-claim/claim
Visibility
Authentication
Session token
MFA Requirement
Not required
POST
/v1/trading/daily-claim/claim Request
Testnet
curl --request POST \ \ --url 'https://api.testnet.polyester.com/v1/trading/daily-claim/claim' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"campaign": {
"campaignId": "value",
"claimPolicy": "UTC_DAILY",
"description": "Example configuration for the API playground.",
"name": "value"
},
"claimId": "value",
"claimedAt": "2025-01-01T00:00:00Z",
"resetAt": "2025-01-01T00:00:00Z",
"rewards": [
{
"amount": "18.446744073709551617",
"assetCode": "USDC",
"assetId": 100
}
],
"state": "AVAILABLE",
"transfers": [
{
"assetId": 100,
"transferId": "9155001234569"
}
]
} 4 fields
campaignId string
Stable campaign identifier.
Example
value claimPolicy enum
How frequently each root account may claim from this campaign.
UTC_DAILY
Example
UTC_DAILY description string
Campaign description. Existing claims retain the description that applied when they were created.
Example
Example configuration for the API playground. name string
Campaign name. Existing claims retain the name that applied when they were created.
Example
value claimId string
Claim identifier.
Example
value claimedAt string (date-time)
Time when the claim completed. Omitted while the claim is processing.
Example
2025-01-01T00:00:00Z resetAt string (date-time)
Start of the next UTC calendar day.
Example
2025-01-01T00:00:00Z 3 fields
amount string
Claim amount in 18-decimal unified asset units.
Example
18.446744073709551617 assetCode string
Asset code.
Example
USDC assetId integer (int32)
Asset identifier.
Example
100 state enum
Current claim state.
AVAILABLE PROCESSING CLAIMED UNAVAILABLE
Example
AVAILABLE 2 fields
assetId integer (int32)
Asset identifier.
Example
100 transferId string
Transfer identifier.
Example
9155001234569| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |