Sign in
Groups

Get group information

Retrieves information about the specified group, including its groupId and the list of its child tracked sources.

get/v1/groups/{groupId}

Path parameters

groupIdstring required

The unique identifier for the group.

Response

Group information retrieved 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"
    }
  ]
}

Changes

Changed in 4 of the 40 revisions of this API.35

  • cfaf4efd4ea823See the full diff
    • ▲

      the code response's property type/format changed from integer/ to string/ for status 404

      response-property-type-changed

    • ▲

      removed the required property error from the response with the 404 status

      response-required-property-removed

    • ○

      added the optional property httpCode to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property reason to the response with the 404 status

      response-optional-property-added

  • de4c3fa163841See the full diff
    • ○

      api operation id Get was added

      api-operation-id-added

  • 72a2dfa269761See the full diff
    • ○

      endpoint added

      endpoint-added

  • b5092f2045991See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog