Honeycluster Docs – Register an address for tracking

accounts

post

/accounts/track

operationId: account-track

Adds an XRPL address to the tracked-accounts registry so it begins receiving enriched indexing on the next tick. Idempotent — repeat calls re-activate a previously-paused address.

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.

Request Body

application/json

required

Field	Type	Default	Description
`address` required	string		XRPL address to add to the registry.
`reason` required	string		Human-readable reason this address is being tracked.
`source`	string	`"api"`	Registration source tag (default: `api`).

Example

Json

{
  "address": "rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY",
  "reason": "string",
  "source": "api"
}

Responses

200

application/json

Successful response

Field	Type	Description
`address`	string	XRPL address being tracked (primary key).
`source`	string	How the address was added: `launchpad_registry` \| `domain_toml` \| `object_owner` \| `api` \| `seed` \| `manual`.
`reason`	object
`active`	boolean	When false, the indexer skips refresh jobs for this address.
`backfillCompletedAt`	object	When the initial backfill completed, Unix-seconds.
`addedAt`	integer	Record creation timestamp, Unix-seconds.
`updatedAt`	integer	Record update timestamp, Unix-seconds.

Example

Json

{
  "address": "string",
  "source": "string",
  "reason": "string",
  "active": false,
  "backfillCompletedAt": 1745798400,
  "addedAt": 1745798400,
  "updatedAt": 1745798400
}

400

application/json

Invalid input data

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

application/json

Authorization not provided

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

application/json

Insufficient access

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}