Create Address Set

POST

API for creating an Address Set. An Address Set is a reusable collection of addresses that can be attached to Webhooks as monitoring targets. You can register addresses with addresses at creation time or leave it empty and add them later.The address format (addressFormat) is required and must be either EVM or TRON. It cannot be changed after creation. Up to 1,000 addresses can be registered in a single request.The addressSetId in the response: 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.

Request Body

namestringrequired

Parameter that specifies the name of the Address Set. Up to 128 characters. Duplicate names are allowed.

descriptionstring

Parameter that specifies the description of the Address Set. Up to 512 characters.

addressFormatstringrequired

Required parameter that specifies the format of addresses stored in the Address Set. Either EVM or TRON; there is no default. It cannot be changed after creation.

addressesarray

List of addresses to register at creation time. If omitted or empty, a set with no addresses is created. Up to 1,000 addresses can be provided, and every address must match addressFormat.

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: addressFormat"
}

X-API-KEY

cURL

curl -X POST 'https://web3.nodit.io/v1/webhook/address-sets' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "name": "exchange-hot-wallets",
    "description": "Hot wallets monitored for deposits",
    "addressFormat": "EVM",
    "addresses": [
      "0xabc0000000000000000000000000000000000001",
      "0xabc0000000000000000000000000000000000002"
    ]
  }'