Get Address Set

GET

API for retrieving the details of an Address Set by its addressSetId. You can check the set's status, address count, number of attached Webhooks, and more.

Path Parameters

addressSetIdstringrequired

Parameter that specifies the addressSetId assigned to the Address Set. Use the addressSetId returned when the Address Set was created. It is a 19-digit number but is returned as a string in JSON. Parsing it as a number in JavaScript or similar environments loses precision, so always handle it as a string.

Responses

addressSetIdstringrequired

Field indicating the addressSetId assigned to the Address Set. The addressSetId is a unique value that identifies the Address Set and is used to retrieve, update, or delete it. It is a 19-digit number but is returned as a string in JSON. Parsing it as a number in JavaScript or similar environments loses precision, so always handle it as a string.

namestringrequired

Field indicating the name of the Address Set. Up to 128 characters.

descriptionstringrequired

Field indicating the description of the Address Set. Up to 512 characters; an empty string ("") for a set without a description.

addressFormatstringrequired

Field indicating the format of addresses stored in the Address Set. Either EVM or TRON; it cannot be changed after creation.

statusstringrequired

Field indicating the status of the Address Set. READY means addresses can be changed and the set can be attached to Webhooks; IMPORTING means a CSV import is in progress. While the status is IMPORTING, addresses cannot be changed and the set cannot be attached to a Webhook (name and description can still be updated). A deleted set stops being retrievable immediately after deletion (404), so no separate deletion status appears in responses.

addressCountintegerrequired

Field indicating the total number of addresses stored in the Address Set.

webhookCountintegerrequired

Field indicating the number of Webhooks currently using this Address Set. The set cannot be deleted when this value is 1 or more.

createdAtstringrequired

Indicates when the Address Set was created. This field is returned in ISO 8601 format.

updatedAtstringrequired

Indicates when the Address Set was last modified. This field is returned in ISO 8601 format.

codestringrequired

Code identifying the cause of the failed request.

messagestringrequired

Detailed message including the name and value of the invalid parameter.

{
  "code": "MISSING_REQUIRED_PARAMETER",
  "message": "Missing required parameter: { PARAMETER_NAME }"
}

X-API-KEY

cURL

curl -X GET 'https://web3.nodit.io/v1/webhook/address-sets/1788439512345678901' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo'