fabrica-land Metadata API

openapi: 3.2.0
info:
  title: fabrica-v3-api Metadata API
  description: Fabrica V3 Token API built in TypeScript, Nest.js, and GraphQL
  version: 4.1.7
  contact:
    name: Fabrica Inc.
    url: https://www.fabrica.land/
    email: hello@fabrica.land
servers:
- url: https://api.fabrica.land
- url: https://go.fabrica.land
- url: https://media.fabrica.land
- url: https://metadata.fabrica.land
tags:
- name: Metadata
paths:
  /{networkName}/{contractAddress}/{tokenId}:
    get:
      description: Assembles NFT metadata for marketplaces in OpenSea metadata format
      operationId: getMetadata
      parameters:
      - name: tokenId
        required: true
        in: path
        schema:
          example: 12345678
          type: number
      - name: contractAddress
        required: true
        in: path
        schema:
          example: '0xb52ED2Dc8EBD49877De57De3f454Fd71b75bc1fD'
          type: string
      - name: networkName
        required: true
        in: path
        schema:
          $ref: '#/components/schemas/NetworkName'
      responses:
        '200':
          description: OK is returned as long as the token exists and is successfully found on the provided network (blockchain). If the definition or third-party property information cannot be looked up, the description in the response body may contain an error message instead of the property description. If the definition cannot be looked up, an error name may appear in the name field (e.g. BadGatewayException)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataDto'
        '400':
          description: Returned if the networkName isn't supported, the provided contract address isn't one of Fabrica's contracts on that network, or one of the path params is not in the expected format
        '401':
          description: Returned if the provided token isn't using Fabrica for its validator contract
        '404':
          description: Returned if no token exists for the provided contract
        '502':
          description: Returned if the token returned from the blockchain is in an unexpected format for the provided contract
      summary: Get Metadata
      tags:
      - Metadata
components:
  schemas:
    MetadataAttributeDto:
      type: object
      properties:
        display_type:
          type:
          - string
          - 'null'
          enum:
          - number
          - boost_number
          - boost_percentage
          - date
        max_value:
          type:
          - string
          - 'null'
          minLength: 1
        trait_type:
          type: string
          minLength: 1
        value:
          oneOf:
          - type: string
            minLength: 1
          - type: number
      required:
      - trait_type
      - value
    NetworkName:
      type: string
      enum:
      - ethereum
      - sepolia
    MetadataDto:
      type: object
      properties:
        name:
          type: string
          example: APN 074-142-22, santa-cruz, CA
        image:
          type: string
          example: https://media.fabrica.land/ethereum/0x534137ae9f67c534878aa6edf554dd45e1be1265/14533765190045828665/image?theme=dark
        image_light:
          type: string
          example: https://media.fabrica.land/ethereum/0x534137ae9f67c534878aa6edf554dd45e1be1265/14533765190045828665/image?theme=light
        description:
          type: string
          example: Possession of this NFT grants full rights to the **real property** in the County of santa-cruz (CA) described as:\n\n---\n\n`Lots 37, 38 and 39 in Block 12, as shown and delineated on Zayante Lakes Subdivision No. 4 filed for record in Map Book 25 Page 3 Santa Cruz County Records.`\n\n---\n\nThe property has a provenance score of 0. Detailed information about the property and its score [can be found here](https://testnets.fabrica.land/property/16266859686070254879).\n\nLegal Title of the property is held in the holding entity *Fabrica KNEU2T Trust* linked to this NFT and recorded at the County of santa-cruz, CA ([proof of title](https://ipfs.fabrica.land/ipfs/QmRb48wGf9kP93RqzLdM4SsNo9GwfPrgcj7ixeSxHZTtHi)). **By electronically signing a transaction to acquire the NFT, the buyer acknowledges and accepts all terms, duties and liabilities described in the [Operating Agreement](ipfs://QmQsWprJjxxQVQiDvPHSXcUDc5seWEfQ8XYGdKZqSoA5kv)**.
        animation_url:
          type: string
          example: https://media.fabrica.land/ethereum/0x534137ae9f67c534878aa6edf554dd45e1be1265/14533765190045828665/animation
        external_url:
          type: string
          example: https://testnets.fabrica.land/property/16266859686070254879
        attributes:
          example:
          - trait_type: Country
            value: US-RI
          - trait_type: Holding Entity
            value: Fabrica KNEU2T Trust
          - trait_type: Acres
            display_type: number
            value: 0.52
          - trait_type: City
            value: Zayante
          - trait_type: County
            value: santa-cruz
          - trait_type: State
            value: CA
          - trait_type: Parcel
            value: 074-142-22
          type: array
          items:
            $ref: '#/components/schemas/MetadataAttributeDto'
      required:
      - name
      - image
      - image_light
      - description
      - external_url
  securitySchemes:
    BearerToken:
      scheme: bearer
      bearerFormat: JWT
      type: http
    DynamicXyzJwt:
      scheme: bearer
      bearerFormat: jwt
      type: http
x-provenance:
  method: searched
  source: https://docs.fabrica.land/reference
  harvested: '2026-10-30'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.fabrica.land/reference/cancelofframp.md
  - https://docs.fabrica.land/reference/cancelonramp.md
  - https://docs.fabrica.land/reference/cancelproofofownership.md
  - https://docs.fabrica.land/reference/cancelterrainprojectlisting.md
  - https://docs.fabrica.land/reference/changeofownershipcontroller_savecollectedfieldsforchangeofownership.md
  - https://docs.fabrica.land/reference/claimonramppremint.md
  - https://docs.fabrica.land/reference/documentcontroller_convertmarkdowncontenttopdfcontent.md
  - https://docs.fabrica.land/reference/documentcontroller_convertmarkdowntopdf.md
  - https://docs.fabrica.land/reference/generatepdf417barcode.md
  - https://docs.fabrica.land/reference/getanimationhtml.md
  - https://docs.fabrica.land/reference/getcollectionimage.md
  - https://docs.fabrica.land/reference/getimage.md
  - https://docs.fabrica.land/reference/getmetadata.md
  - https://docs.fabrica.land/reference/getofframp.md
  - https://docs.fabrica.land/reference/getofframps.md
  - https://docs.fabrica.land/reference/getonramp.md
  - https://docs.fabrica.land/reference/getonramps.md
  - https://docs.fabrica.land/reference/getpoollendingoraclereport.md
  - https://docs.fabrica.land/reference/getpoollendingvaluation.md
  - https://docs.fabrica.land/reference/getproofofownership.md
  - https://docs.fabrica.land/reference/getregridtile.md
  - https://docs.fabrica.land/reference/getstepsandfieldsforofframp.md
  - https://docs.fabrica.land/reference/getstepsandfieldsforonramp.md
  - https://docs.fabrica.land/reference/getstepsandfieldsforproofofownership.md
  - https://docs.fabrica.land/reference/gettitledocs.md
  - https://docs.fabrica.land/reference/getvaluation.md
  - https://docs.fabrica.land/reference/getvaluationreport.md
  - https://docs.fabrica.land/reference/issueonrampclaimsession.md
  - https://docs.fabrica.land/reference/markonrampcelebrationcomplete.md
  - https://docs.fabrica.land/reference/onrampproperty.md
  - https://docs.fabrica.land/reference/patchonramp.md
  - https://docs.fabrica.land/reference/patchonrampconfiguration.md
  - https://docs.fabrica.land/reference/patchtokenconfiguration.md
  - https://docs.fabrica.land/reference/proveownershipofproperty.md
  - https://docs.fabrica.land/reference/retsfeed.md
  - https://docs.fabrica.land/reference/syncterrainprojectlisting.md
  - https://docs.fabrica.land/reference/updateonrampconfiguration.md
  merge:
    pages: 37
    deduped: 89
    conflicts_kept_first: 0