import { exec } from 'child_process'
import { resolve } from 'path'
import { globSync } from 'glob'
import chokidar from 'chokidar'
import { fileURLToPath } from 'url'
import { dirname } from 'path'

const __filename = fileURLToPath(import.meta.url)
const __dirname = dirname(__filename)

// Start the Mintlify dev server using the new mint command
const mintlifyDev = exec('mint 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)


Verifies a one-time password for a given email and optionally returns user information.

Verify OTP

ApiKeyAuth

Bad request. Validation failed for query parameters.

Documentation for the One of None API. You can use this set of tools to interact with your NFC tagged products.

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 a user (identified by email or user_id) owns a registered product in a collection, with optional token_id filtering.

Check ownership

Retrieves a paginated list of registered products owned by a specific user, filtered by email or user_id and optionally by collection.

List owned products

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

Create OTP

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

Create nonce

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

Verify signature

Retrieves the registration settings for a specific product, identified by token_id and collection (slug or ID).

Get registration settings

Fetches activities for a specific collection or product. If collection_slug is provided, returns collection and optionally product activities. Otherwise, returns team customer activities.

List activities

Creates a new customer activity for a product, including an image upload.

Create an activity

Update activity

Delete activity

Retrieve analytics for block clicks over a specified date range, with various filters and aggregation levels. The endpoint supports filtering by team, collection, token, block type, and various other parameters. Results can be aggregated at different time intervals (daily, weekly, monthly, quarterly, yearly).


Get block click analytics

Retrieve lifetime analytics for a product, including sales, taps, registrations, and other metrics. The endpoint supports filtering by team, collection, product, and geographic location. Results include aggregated metrics across all time periods.


Get lifetime product analytics

Retrieve analytics for product registrations over a specified date range, with various filters and aggregation levels. The endpoint supports filtering by team, collection, product, and various other parameters. Results can be aggregated at different time intervals (daily, weekly, monthly, quarterly, yearly).


Get product registration analytics

Retrieve analytics for product taps over a specified date range, with various filters and aggregation levels. The endpoint supports filtering by team, collection, product, and various other parameters. Results can be aggregated at different time intervals (daily, weekly, monthly, quarterly, yearly).


Get taps analytics

Retrieve analytics for vault interactions over a specified date range, with various filters and aggregation levels. The endpoint supports filtering by team, collection, token, and various other parameters. Results can be aggregated at different time intervals (daily, weekly, monthly, quarterly, yearly).


Get vault analytics

Retrieve detailed analytics for a specific product short url, including device information, location, and other metrics. The endpoint provides insights into how a particular tap was generated and its associated metadata.


Get analytics for a specific short url

Fetches a list of collections with optional filters such as status, blockchain, and quantity. Results can be paginated and ordered by various fields. The endpoint supports filtering by collection status, blockchain chain, and quantity range.


List collections

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. Optionally include a `token_id` to also fetch the registration status for that token.


Get collection

Fetches the blocks associated with a collection. The response includes block containers and their associated blocks, ordered by the block's position. Results can be paginated.


List collection blocks

Retrieves metadata for a collection by its slug. This endpoint is publicly accessible and returns basic collection information including name, description, and image URL.


Get collection metadata

Fetches a list of product registrations with optional filters such as email, collection, token, wallet, and status. Results can be paginated and ordered by various fields. The endpoint supports filtering by registration status, date range, and various identifiers.


List registrations

Fetches a single product registration by its unique identifier (ID), short URL, or collection slug. Use the `type` query parameter to specify whether to query by `ID`, `SHORT_URL`, or `SLUG`. When using `SLUG` type, a `token_id` must be provided.


Get registration

Creates a new product registration using a wallet address. This endpoint is used to register a product using a blockchain wallet address. The registration can be associated with a specific collection and token ID.


Create a wallet registration

Creates a new product registration using an email address. This endpoint is used to register a product using an email address. The registration can be associated with a specific collection and token ID. An email verification will be sent to the provided address.


Create an email registration

Updates the metadata for a product registration. The metadata can include additional information about the registration such as personal details or custom fields.


Update registration metadata

Fetches a list of short URLs with optional filtering and pagination. Short URLs can be filtered by collection, token, title, destination URL, creation/update dates, and tap count. Collection information can be included in the response if requested.


List short URLs

Fetches a single short URL by its URL identifier. Collection information can be included in the response if requested.


Get short URL

Updates the metadata and/or registration settings for a short URL. At least one of metadata or registration_settings must be provided.


Update short URL

Fetches the team information associated with the API key. This endpoint returns the team's profile information, settings, and associated addresses.


Get team

Fetches the app settings for the team associated with the API key. This includes branding, layout, typography, colors, and other configuration settings for the team's custom app.


Get team app settings

Fetches the inventory information for the team associated with the API key. This includes chip model details, quantities in various states (available, encoded, owned, reserved, damaged), and other inventory tracking information.


Get inventory

Fetches a list of orders for the team associated with the API key. Orders can be filtered by order number, email, and date range. Results are paginated.


List orders

Fetches a single order by its order number for the team associated with the API key.


Get order

Fetches a list of users for the team associated with the API key. Users can be filtered by email, phone, app ID, login count, and various date ranges. Results are paginated.


List users

Fetches a single user by their ID or email address. Use the `type` query parameter to specify whether to query by `ID` or `EMAIL`. When using `EMAIL` type, the ID parameter must be a valid email address.


Get user

Updates a user's information including phone number, email address, and metadata. All fields are optional - only provided fields will be updated.


Update user

Updates multiple users in a single request. Users can be provided either as an array of user objects or as a CSV string. The CSV should have headers for email (required), phone (optional), and metadata (optional). If metadata is provided in the CSV, it should be a valid JSON string.


Batch update users

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

Generate a one-time password (OTP)

Verifies a one-time password for a given email.

Verify a one-time password (OTP)

Generate a nonce for signature authentication

Fetches activities for a specific collection or product.

Get activities

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.

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.

Getting Started

Access API

Activities API

Analytics API

Collections API

Registrations API

Short URLs API

Teams API

Users API

Verify OTP

Authorizations

Body

Response