> ## Documentation Index
> Fetch the complete documentation index at: https://docs.digitalasset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get apitoken standardv0registrars registrymetadatav1instruments 1

> Retrieve an instrument's metadata.



## OpenAPI

````yaml /registry/apis/open-api-specs/utility-token-standard/v1/token-metadata-v1.yaml get /api/token-standard/v0/registrars/{registrarParty}/registry/metadata/v1/instruments/{instrumentId}
openapi: 3.0.0
info:
  title: token metadata service
  description: >
    This is a fork of the official Open API spec defined as part of CIP 56.


    The only difference is in the URL prefix, which explicitly requires setting
    the `registrarParty` path parameter.


    This spec should not be used for client-side code generation, use the
    official one instead.
  version: 1.0.0
servers:
  - url: https://api.utilities.digitalasset.com
    description: MainNet
  - url: https://api.utilities.digitalasset-staging.com
    description: TestNet
  - url: https://api.utilities.digitalasset-dev.com
    description: DevNet
  - url: http://localhost:8080
    description: Local
security: []
paths:
  /api/token-standard/v0/registrars/{registrarParty}/registry/metadata/v1/instruments/{instrumentId}:
    get:
      tags:
        - public
      description: Retrieve an instrument's metadata.
      operationId: getInstrument
      parameters:
        - name: registrarParty
          in: path
          required: true
          schema:
            type: string
          description: The registrar party.
        - name: instrumentId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Instrument'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
components:
  schemas:
    Instrument:
      type: object
      properties:
        id:
          description: The unique identifier assigned by the admin to the instrument.
          type: string
        name:
          description: >-
            The display name for the instrument recommended by the instrument
            admin. This is not necessarily unique.
          type: string
        symbol:
          description: >-
            The symbol for the instrument recommended by the instrument admin.
            This is not necessarily unique.
          type: string
        totalSupply:
          description: Decimal encoded current total supply of the instrument.
          type: string
        totalSupplyAsOf:
          description: The timestamp when the total supply was last computed.
          type: string
          format: date-time
        decimals:
          description: >
            The number of decimal places used by the instrument.


            Must be a number between 0 and 10, as the Daml interfaces represent
            holding amounts as

            `Decimal` values, which use 10 decimal places and are precise for 38
            digits.

            Setting this to 0 means that the instrument can only be held in
            whole units.


            This number SHOULD be used for display purposes in a wallet to
            decide how many

            decimal places to show and accept when displaying or entering
            amounts.
          type: integer
          format: int8
          default: 10
        supportedApis:
          $ref: '#/components/schemas/SupportedApis'
      required:
        - id
        - name
        - symbol
        - decimals
        - supportedApis
    SupportedApis:
      description: >
        Map from token standard API name to the minor version of the API
        supported, e.g.,

        splice-api-token-metadata-v1 -> 1 where the `1` corresponds to the minor
        version.
      type: object
      additionalProperties:
        type: integer
        format: int32
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
  responses:
    '404':
      description: not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '500':
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'

````