rewards

POST /rewards/claim

Claims all the filtered undisbursed rewards for a user

Request

Base URL
https://api.audius.co/v1
Auth
none declared
TypeScript
https://skmtc.dev/audius/apis/audius-api/docs/rewards/claim/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

challengeIdstring

The challenge ID to filter rewards (optional)

specifierstring

The specifier to filter rewards (optional)

userIdstring required

The user ID to claim rewards for

Example request

{
  "challengeId": "u",
  "specifier": "7eP5n",
  "userId": "7eP5n"
}

Response

Success

Example response

{
  "data": [
    {
      "challengeId": "u",
      "specifier": "7eP5n",
      "amount": "1000000000",
      "signatures": [
        "5j7s1QjmRKFuDbCWMRVRNibSV2VAAEcNKP6HWU7GwPdXkBZvhz8n4vQl7bBq8tN4Rz9x1Kj3mP5wQ8rT2Y6zA"
      ],
      "error": "Insufficient balance"
    }
  ]
}

Changes

No recorded changes to this operation across all 11 revisions of this API.