ClaimsService

Get Daily Claim Status

Get today's reward and claim status for the authenticated root account. Requires a session JWT; API keys are not accepted. Future reward schedules are not returned.

Method

GET

Path

/v1/trading/daily-claim

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

GET

/v1/trading/daily-claim

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/trading/daily-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",
  "payoutDelayReason": "CLAIM_TEMPORARILY_UNAVAILABLE",
  "resetAt": "2025-01-01T00:00:00Z",
  "rewards": [
    {
      "amount": "18.446744073709551617",
      "assetCode": "USDC",
      "assetId": 100
    }
  ],
  "state": "AVAILABLE",
  "subaccountId": "45LUmqjT"
}

4 fields

claimId string

Claim identifier. Empty until a claim has been created.

Example value

payoutDelayReason enum

Why the payout of today's claim is delayed: the claim reward is temporarily unavailable, or reward payouts for this campaign are paused. Set only while the state is payout delayed; unspecified or omitted otherwise.

CLAIM_TEMPORARILY_UNAVAILABLE UNAUTHENTICATED RATE_LIMIT_EXCEEDED CLAIM_UNAVAILABLE CONFLICT INVALID_REQUEST REQUEST_TOO_LARGE SERVICE_UNAVAILABLE INTERNAL_ERROR PERMISSION_DENIED FAILED_PRECONDITION SOCIAL_VERIFICATION_REQUIRED SUBACCOUNT_NOT_FOUND SUBACCOUNT_INACTIVE CLAIM_PAYOUT_UNAVAILABLE

Example CLAIM_TEMPORARILY_UNAVAILABLE

resetAt string (date-time)

Start of the next UTC calendar day.

Example 2025-01-01T00:00:00Z

3 fields

state enum

Current state of today's claim.

AVAILABLE PROCESSING CLAIMED UNAVAILABLE PAYOUT_DELAYED

Example AVAILABLE

subaccountId string /^[1-9A…m-z]+$/

Subaccount public id that receives today's claimed reward. Zero or omitted when no claim has been created yet or when the reward is paid to the root account.

Example 45LUmqjT

Possible errors: 5

Key	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	Unavailable	Service unavailable.

GET

/v1/trading/daily-claim

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/trading/daily-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",
  "payoutDelayReason": "CLAIM_TEMPORARILY_UNAVAILABLE",
  "resetAt": "2025-01-01T00:00:00Z",
  "rewards": [
    {
      "amount": "18.446744073709551617",
      "assetCode": "USDC",
      "assetId": 100
    }
  ],
  "state": "AVAILABLE",
  "subaccountId": "45LUmqjT"
}