Utility

Utility endpoints

Refresh CarbonRegistry.com's onchain transaction indexers

Callable by any access token regardless of permissions. Calling this endpoint refreshes the CarbonRegistry.com's indexing services so they can more quickly generate transaction receipts and retirement certificates. Especially useful for onchain retirements that happen off the CarbonRegistry.com platform when users want the retirement certificate to be generated more quickly.

Refresh CarbonRegistry.com's onchain transaction indexers

Pings our indexers. Could be used to speed up CarbonRegistry.com's indexing of onchain data.

POSThttps://api.carbonregistry.com/carbonRegistry/onchain/indexer/refresh

Response

200

Body

application/json

transactionId*string

success*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/carbonRegistry/onchain/indexer/refresh', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "transactionId": "text",
  "success": false
}

cURL

curl -X 'POST' \
  'https://api.carbonregistry.com/carbonRegistry/onchain/indexer/refresh' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'