Getting Started

Documentation for version: v0.2.4

Overview

offchain is an open-source Python package that makes it easy to index both onchain and offchain NFT metadata. Now anyone can define and standardize the indexing of custom NFT metadata schemas.

offchain powers the Zora Indexer, meaning any contributions to metadata parsing implementations will be reflected in the Zora API. Check out the Contributing page to implement custom metadata.

Lastly, please review the Core Concepts page before reading the rest of the documentation.

Installation

with pip:

pip install offchain

with poetry:

poetry add offchain

from repository:

pip install git+https://github.com/ourzora/offchain.git