Claim App Fees - Relay

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

cURL

curl --request POST \
  --url https://api.relay.link/app-fees/{wallet}/claim \
  --header 'Content-Type: application/json' \
  --data '
{
  "chainId": 123,
  "currency": "<string>",
  "recipient": "<string>"
}
'

JavaScript

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({chainId: 123, currency: '<string>', recipient: '<string>'})
};

fetch('https://api.relay.link/app-fees/{wallet}/claim', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Python

import requests

url = "https://api.relay.link/app-fees/{wallet}/claim"

payload = {
    "chainId": 123,
    "currency": "<string>",
    "recipient": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Status Codes

• 200
• 400

Example Response

{
  "steps": [
    {
      "id": "<string>",
      "action": "<string>",
      "description": "<string>",
      "kind": "<string>",
      "items": [
        {
          "status": "<string>",
          "data": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": "<string>"
}

Endpoint Details

• POST: https://api.relay.link/app-fees/{wallet}/claim

Headers

• x-api-key: string (Optional API key for authentication and higher rate limits.)

Path Parameters

• wallet: string (required)

Body

• chainId: number (required) - Chain id of the currency to claim
• currency: string (required) - Currency to claim
• recipient: string (required) - The recipient of the claimed funds
• amount: string - Amount to claim (Pattern: ^[0-9]+$)

Response

• 200: application/json

• Default Response

• steps: object[] - An array of steps detailing what needs to be done to claim.