Skip to main content

List Addresses in Address Set

GET
API for retrieving the addresses stored in an Address Set with cursor-based pagination. Prefix search on addresses is supported via search.If the response contains cursor, pass it as the cursor parameter in the next request to continue. On the last page the cursor field itself is absent from the response, so check for the presence of cursor to detect the end.
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.
Query Parameters
cursorstring
The cursor value from the previous response. Omit when fetching the first page.
sizeinteger
Specifies the number of addresses to return per request. The valid range is 1 to 1,000. The default is 100.
searchstring
Address prefix matching. For EVM sets the input is normalized to lowercase before matching; for TRON sets matching is case-sensitive.
Responses
List of retrieved addresses. Each item is an object that currently has only an address field. The registration time (createdAt) is not included.
addressstringrequired
An address matching the set's addressFormat. EVM addresses (0x + 40 hex) are case-insensitive and normalized to lowercase for storage. TRON addresses (Base58, 34 characters starting with T) are case-sensitive.
cursorstring
Value to pass as the cursor parameter to fetch the next page. On the last page this field is absent from the response (the field itself is missing, not null).
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 }"
}
cURL
curl -X GET 'https://web3.nodit.io/v1/webhook/address-sets/1788439512345678901/addresses?cursor=eyJhZGRyZXNzIjoiMHhhYmMwLi4uMDAwMiJ9&size=100&search=0xabc' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo'