Deposit Address Reindex - Relay

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

cURL Example

curl --request POST \
  --url https://api.relay.link/transactions/deposit-address/reindex \
  --header 'Content-Type: application/json' \
  --data '
{
  "chainId": 123,
  "depositAddress": "<string>"
}
'

JavaScript Fetch Example

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

fetch('https://api.relay.link/transactions/deposit-address/reindex', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Python Requests Example

import requests

url = "https://api.relay.link/transactions/deposit-address/reindex"

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

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

print(response.text)

Response Codes

• 200: Successful request.
• 400: Bad request.
• 403: Forbidden.
• 404: Not found.
• 429: Too many requests.
• 503: Service unavailable.

Example Response

{
  "message": "<string>",
  "triggeredCurrencies": [
    {
      "currency": "<string>",
      "symbol": "<string>",
      "balance": "<string>"
    }
  ],
  "checkedCurrencies": 123,
  "failedCurrencies": 123
}

Headers

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

Body Parameters

• chainId: number (required) - Chain ID the deposit address was originally registered on.
• depositAddress: string (required) - The deposit address to reindex.
• sweep: boolean (Deprecated. No longer supported on this endpoint.)
• targetChainId: number - Chain ID to reindex on, when different from chainId.
• currency: string - Address of a specific currency to reindex.

Response

200 (application/json)

• message: string (Human-readable summary of the reindex outcome.)
• triggeredCurrencies: object[] (Currencies for which a withdrawal was queued.)
• checkedCurrencies: number (Total number of currencies whose balance was checked.)
• failedCurrencies: number (Number of currencies whose balance check failed.)