Skip to main content

Registry Endpoint

Retrieve detailed information about registry items, including metadata and total amounts.

Endpoint​

GET /v1/registry/item/{id}

Purpose​

Retrieve detailed information about a specific registry item. This registry lets minters attach metadata to deeds and keep track of their totals.

Path Parameter​

  • id (required)
    • Type: string
    • Description: The identifier of the registry item.

Response​

Success Response (200 OK)​

{
  "id": "deed_2samLx0gNPgbb6o3JxKMSWSzz3E",
  "total": 100,
  "metadata": "Funding deed for project Alpha"
}

Parameters​

  • id

    • Type: string
    • Description: Registry item identifier.

  • total

    • Type: integer
    • Constraints: Must be greater than 0.
    • Description: The total amount of units for this deed.

  • metadata

    • Type: string or null
    • Description: Optional metadata associated with the deed. May be null if no metadata was provided.

Error Response (404 Not Found)​

Returned if no registry item exists with the specified id.

Example​

Request​

GET /v1/registry/item/deed_2samLx0gNPgbb6o3JxKMSWSzz3E

Response​

{
  "id": "deed_2samLx0gNPgbb6o3JxKMSWSzz3E",
  "total": 100,
  "metadata": "Funding deed for project Alpha"
}

Use Cases​

The registry endpoint is useful for:

  • Verifying the authenticity of a deed
  • Checking the total amount of units minted for a particular deed
  • Retrieving the metadata associated with a deed
  • Building user interfaces that display deed information