Sign in

v1

latestOpenAPI 3.0.02026-07-174823135.4 KB
Groups

Create or overwrite a group

Creates a new group with the specified groupId. If a group with the same groupId already exists, it will be overwritten.

post/v1/groups/{groupId}

Path parameters

groupIdstring required

The unique identifier for the group.

Request body

childrenstring[]

An array of tracked sources (derivation schemes or other groups) to be included in the group.

Response

Group created or overwritten successfully.

trackedSourcestring required

The tracked source identifier for the group, formatted as 'GROUP:{groupId}'. Used to reference the group within NBXplorer.

groupIdstring required

The unique identifier of the group.

Example response

{
  "trackedSource": "GROUP:6N23bHztah546P6xQT",
  "groupId": "6N23bHztah546P6xQT",
  "children": [
    {
      "trackedSource": "DERIVATIONSCHEME:tpubDC6xFicnheK85vUNGjegu4HuJGg8nPi...",
      "cryptoCode": "BTC"
    }
  ]
}