Claims

Claim management operations

Get pending claims

get

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/claims

Retrieve pending claims for the authenticated user

Responses

200

Pending claims

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

500

Internal server error

application/json

get

/api/claims

HTTPcURLJavaScriptPython

GET /api/claims HTTP/1.1
Host: rewards.decentraland.org
Accept: */*

{
  "ok": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": "0x1234567890123456789012345678901234567890",
      "chain_id": "137",
      "contract": "0x1234567890123456789012345678901234567890",
      "transaction_payload": "0x1234567890abcdef",
      "transaction_payload_hash": "0xabcdef1234567890",
      "status": "claimed",
      "rewards": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "expires_at": "2024-12-31T23:59:59Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Create claim

post

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/claims

Create a new claim for rewards

Body

application/json

rewardsstring · uuid[]Optional

Reward IDs to claim

Example: ["123e4567-e89b-12d3-a456-426614174000"]

Responses

201

Claim created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/api/claims

HTTPcURLJavaScriptPython

POST /api/claims HTTP/1.1
Host: rewards.decentraland.org
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "rewards": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "ok": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "user": "0x1234567890123456789012345678901234567890",
    "chain_id": "137",
    "contract": "0x1234567890123456789012345678901234567890",
    "transaction_payload": "0x1234567890abcdef",
    "transaction_payload_hash": "0xabcdef1234567890",
    "status": "claimed",
    "rewards": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "expires_at": "2024-12-31T23:59:59Z",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Get claim details

get

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/claims/{claim}

Retrieve detailed information about a specific claim

Path parameters

claimstring · uuidRequired

Claim ID

Responses

200

Claim details

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/api/claims/{claim}

HTTPcURLJavaScriptPython

GET /api/claims/{claim} HTTP/1.1
Host: rewards.decentraland.org
Accept: */*

{
  "ok": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "user": "0x1234567890123456789012345678901234567890",
    "chain_id": "137",
    "contract": "0x1234567890123456789012345678901234567890",
    "transaction_payload": "0x1234567890abcdef",
    "transaction_payload_hash": "0xabcdef1234567890",
    "status": "claimed",
    "rewards": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "expires_at": "2024-12-31T23:59:59Z",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Get claim rewards

get

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/claims/{claim}/rewards

Retrieve rewards associated with a specific claim

Path parameters

claimstring · uuidRequired

Claim ID

Responses

200

Claim rewards

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/api/claims/{claim}/rewards

HTTPcURLJavaScriptPython

GET /api/claims/{claim}/rewards HTTP/1.1
Host: rewards.decentraland.org
Accept: */*

{
  "ok": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
      "campaign_key": "123e4567-e89b-12d3-a456-426614174000",
      "user": "0x1234567890123456789012345678901234567890",
      "status": "assigned",
      "chain_id": "137",
      "transaction_hash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
      "block_number": 12345678,
      "airdrop_type": "CollectionV2IssueToken",
      "target": "0x1234567890123456789012345678901234567890",
      "value": "1",
      "priority": 1,
      "group": "premium",
      "token": "Summer Hat",
      "image": "https://example.com/image.png",
      "rarity": "rare",
      "category": "hat",
      "from_referral": "0x1234567890123456789012345678901234567890",
      "payload": "0x1234567890abcdef",
      "signature": "0xabcdef1234567890",
      "expires_at": "2024-12-31T23:59:59Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "assigned_at": "2024-01-01T00:00:00Z"
    }
  ]
}