W3Block Docs
  • 🚀Start here
    • Welcome to the Docs
    • Integrated Blockchains
  • 👨‍💻Dev Docs
    • API
      • Getting Started
      • Authentication
      • Commerce API services
        • Company Administration
          • Companies (Admin)
          • Assets (Admin)
          • Tags (Admin)
          • Products (Admin)
            • Order Rules (Admin)
          • Orders (Admin)
          • Faq (Admin)
          • Webhooks (Admin)
        • Products
        • Orders
        • Webhooks
        • Faq
        • Globals
      • Key API Services
        • Authentication
        • Companies
        • Tokens
          • Contracts
            • External Contacts
            • Royalty Eligible
          • Categories
            • Subcategories
          • Token Collections
            • Token Editions
          • Metadata
        • Blockchain
        • Cloudinary
        • Integration
          • Ecommerce
            • Associate Tokens
            • Hooks
        • Users
        • Vouchers
  • 📘Knowledge Base
    • First Steps
    • FAQ
    • Glossary
Powered by GitBook
On this page
  1. Dev Docs
  2. API
  3. Key API Services
  4. Tokens

Metadata

PreviousToken EditionsNextBlockchain

Last updated 2 years ago

👨‍💻
get
Path parameters
collectionIdstringRequired
editionNumbernumberRequired
Responses
200Success
application/json
get
GET /metadata/by-collection/{collectionId}/{editionNumber} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "chainId": 1,
  "contractAddress": "0x0000000000000000000000000000000000000000",
  "editionNumber": 1,
  "tokenId": 1,
  "isAvailable": true,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "minted"
}
get
Path parameters
rfidstringRequired
Responses
200Success
application/json
get
GET /metadata/rfid/{rfid} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "company": {
    "id": "text",
    "name": "text",
    "theme": {
      "headerLogoUrl": "text",
      "headerBackgroundColor": "text",
      "bodyCardBackgroundColor": "text"
    }
  },
  "group": {
    "categoryId": "text",
    "categoryName": "text",
    "subcategoryId": "text",
    "subcategoryName": "text",
    "collectionId": "text",
    "collectionName": "text",
    "collectionPass": true
  },
  "information": {
    "title": "text",
    "mainImage": "text",
    "contractName": "text",
    "description": "text"
  },
  "dynamicInformation": {
    "tokenData": {},
    "publishedTokenTemplate": {
      "prop1": {
        "type": "SELECT",
        "config": {
          "required": {},
          "label": "text",
          "tooltip": "text",
          "placeholder": "text",
          "order": 1,
          "childrenType": "SELECT",
          "range": {
            "min": 1,
            "max": 1
          },
          "options": [
            "text"
          ],
          "float": true
        },
        "children": {}
      },
      "prop2": {
        "type": "SELECT",
        "config": {
          "required": {},
          "label": "text",
          "tooltip": "text",
          "placeholder": "text",
          "order": 1,
          "childrenType": "SELECT",
          "range": {
            "min": 1,
            "max": 1
          },
          "options": [
            "text"
          ],
          "float": true
        },
        "children": {}
      }
    }
  },
  "certificateTemplate": "text",
  "certificateLink": "text",
  "edition": {
    "total": 1,
    "currentNumber": 1,
    "rfid": "text",
    "isMultiple": true,
    "mintedAt": "2025-06-01T14:49:17.444Z",
    "mintedHash": "text"
  },
  "token": {
    "address": "text",
    "chainId": 1,
    "tokenId": 1,
    "firstOwnerAddress": "text",
    "ownerAddress": "text"
  },
  "isMinted": true
}
get
Path parameters
addressstringRequiredExample: 0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188
chainIdstring · enumRequiredExample: 1Possible values:
Responses
200Success
application/json
get
GET /metadata/contract/{address}/{chainId} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "id": "text",
  "image": "text",
  "name": "text",
  "description": "text",
  "external_link": "text",
  "seller_fee_basis_points": "text",
  "fee_recipient": "text"
}
get
Path parameters
addressstringRequiredExample: 0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188
chainIdstring · enumRequiredExample: 1Possible values:
Query parameters
forceRefreshbooleanRequired
showSpambooleanRequired
onlyMintedByWeblockbooleanRequired
Responses
200Success
application/json
default
NFTs for a wallet
get
GET /metadata/nfts/{address}/{chainId}?forceRefresh=true&showSpam=true&onlyMintedByWeblock=true HTTP/1.1
Host: 
Accept: */*
{
  "prop1": {},
  "prop2": {}
}
get
Authorizations
Path parameters
companyIdstringRequired
chainIdstring · enumRequiredExample: 1Possible values:
addressstringRequiredExample: 0x095358452C33916513a3827a2D086da1aCEd7EE0
Responses
200Success
application/json
401
Unauthorized - Integration API key or JWT required
get
GET /metadata/transactions/{companyId}/count/{address}/{chainId} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*
{
  "mint": {
    "started": 1,
    "pending": 1
  },
  "action": {
    "started": 1,
    "pending": 1
  },
  "contract": {
    "started": 1,
    "pending": 1
  },
  "total": {
    "started": 1,
    "pending": 1
  }
}
get
Authorizations
Path parameters
companyIdstringRequired
chainIdstring · enumRequiredExample: 1Possible values:
Responses
200Success
application/json
401
Unauthorized - Integration API key or JWT required
get
GET /metadata/transactions/{companyId}/count/{chainId} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*
{
  "mint": {
    "started": 1,
    "pending": 1
  },
  "action": {
    "started": 1,
    "pending": 1
  },
  "contract": {
    "started": 1,
    "pending": 1
  },
  "total": {
    "started": 1,
    "pending": 1
  }
}
get
Query parameters
pagenumberOptionalDefault: 1
limitnumberOptionalDefault: 10
orderBystring · enumOptionalDefault: DESCPossible values:
startDatestringRequiredExample: 2022-07-15T00:00:00.000Z
endDatestringRequiredExample: 2022-07-20T23:59:59.000Z
sortBystring · enumOptionalPossible values:
Responses
200Success
get
GET /metadata/history?startDate=text&endDate=text HTTP/1.1
Host: 
Accept: */*
200Success

No content

  • GET/metadata/by-collection/{collectionId}/{editionNumber}
  • GET/metadata/rfid/{rfid}
  • GET/metadata/contract/{address}/{chainId}
  • GET/metadata/nfts/{address}/{chainId}
  • GET/metadata/transactions/{companyId}/count/{address}/{chainId}
  • GET/metadata/transactions/{companyId}/count/{chainId}
  • GET/metadata/history