const { exec } = require('child_process')
const { resolve } = require('path')
const { globSync } = require('glob')
const chokidar = require('chokidar')

// Start the Mintlify dev server
const mintlifyDev = exec('node_modules/.bin/mintlify dev')
mintlifyDev.stdout.pipe(process.stdout)
mintlifyDev.stderr.pipe(process.stderr)

// Watch for changes in the YAML files within the api-reference folder
const watcher = chokidar.watch(
  globSync(resolve(__dirname, '..', 'api-reference', 'openapi', '**/*.yaml')),
  {
    persistent: true,
  }
)

// Run swagger-cli bundle on change
watcher.on('change', () => {
  console.log('YAML file changed. Re-running swagger-cli bundle...')
  exec(
    'node_modules/.bin/swagger-cli bundle -r -o ./api-reference/openapi.json ./api-reference/openapi/openapi.yaml',
    (error, stdout, stderr) => {
      if (error) {
        console.error(`Error: ${error.message}`)
        return
      }
      if (stderr) {
        console.error(`stderr: ${stderr}`)
        return
      }
      console.log(stdout)

      // Run the scraper to generate MDX files from the OpenAPI spec
      console.log('Running mintlify-scrape...')
      exec(
        'node_modules/.bin/mintlify-scrape openapi-file api-reference/openapi.json -o api-reference',
        (scrapeError, scrapeStdout, scrapeStderr) => {
          if (scrapeError) {
            console.error(`Error: ${scrapeError.message}`)
            return
          }
          if (scrapeStderr) {
            console.error(`stderr: ${scrapeStderr}`)
            return
          }
          console.log(scrapeStdout)
        }
      )
    }
  )
})

const gracefulShutdown = () => {
  console.log('\nGracefully shutting down...')

  watcher.close()
  mintlifyDev.kill()
  process.exit()
}

process.on('SIGINT', gracefulShutdown)
process.on('SIGTERM', gracefulShutdown)


Retrieves metadata for a specific collection.

Get Collection Metadata

Collection metadata retrieved successfully.

One of None documentation

This guide will walk you through the essential steps to get started with our API, from obtaining your API key to making your first request.

Having trouble getting started with our API? Don’t worry, we’re here to help. Here’s a list of common issues we’ve seen customers run into:

Checks whether the specified wallet is the owner of a product associated with a given address and, optionally, a specific token ID.

Check if user owns a product

Retrieves a list of products owned by a specific user across collections. Results can be filtered by blockchain network and are paginated for larger sets.

Get products owned by a user

Generates a one-time password for a given email, with an optional expiration time, and sends it via email.

Generate a one-time password (OTP)

Verifies a one-time password for a given email.

Verify a one-time password (OTP)

Generates a nonce that can be used for message signing to authenticate a user, valid for 10 minutes.

Generate a nonce for signature authentication

Verifies a user's signature using a previously generated nonce.

Verify signature

Fetches activities for a specific collection or product.

Get activities

Create an activity

Update an activity

Delete an activity

Retrieve analytics for block clicks over a specified date range, with various filters and aggregation levels.


Fetch block click analytics

Retrieve lifetime analytics for a product, including sales, taps, and registrations.


Fetch lifetime product analytics

Retrieve analytics for product registrations over a specified date range, with various filters and aggregation levels.


Fetch product registration analytics

Retrieve analytics for product taps over a specified date range, with various filters and aggregation levels.


Fetch product taps analytics

Retrieve analytics for vault interactions over a specified date range, with various filters and aggregation levels.


Fetch vault analytics

Fetches a list of collections with optional filters such as status, blockchain, quantity, and drop price. Results can be paginated.

Get collection list

Fetches a collection by its unique identifier (ID) or slug. Use the `type` query parameter to specify whether to query by `ID` or `SLUG`. Defaults to querying by slug.

Get collection

Get collection sales

Fetches a list of products, allowing filtering by name, status, grade, registration date, vaulted status, and pagination.

Get product list

Fetches a product by its ID. If a collection slug is provided, the product will be retrieved based on the token ID within that collection.

Get product

Registers a guest for a product, ensuring the short URL is unique and initiates the minting process.

Access

Activities

Analytics

Collections

Products

Metadata

Get Collection Metadata

Path Parameters

Response