# Unlock Protocol

> Unlock Protocol is an open-source, community-governed protocol for onchain memberships and
> subscriptions. Creators deploy "locks" (membership smart contracts) that mint time-based,
> optionally recurring membership NFTs ("keys") on Ethereum, Base, Optimism, Polygon, Arbitrum
> and other networks. The hosted Locksmith API adds off-chain conveniences: metadata storage,
> event ticketing, QR-code verification, fiat (Stripe) payments, webhooks, and email delivery.
> Governance sits with the Unlock DAO and the Unlock Protocol Foundation.

Generated by API Evangelist from the provider's docs and this repository's artifacts (2026-07-21).

## APIs

- [Locksmith API](https://docs.unlock-protocol.com/tools/locksmith/): hosted REST API — metadata, tickets, checkout configs, receipts, Stripe fiat payments, webhooks. Base URL: https://locksmith.unlock-protocol.com
- [Locksmith API reference](https://docs.unlock-protocol.com/category/api): per-operation reference documentation
- [Unlock Subgraphs](https://docs.unlock-protocol.com/tools/subgraph/): GraphQL indexes of the Unlock contracts per network. Dev endpoint: https://subgraph.unlock-protocol.com/<chainId>
- [Smart Contracts API](https://docs.unlock-protocol.com/core-protocol/smart-contracts-api/Unlock): Unlock factory + PublicLock membership contract interfaces
- [RPC Provider](https://docs.unlock-protocol.com/tools/rpc-provider): convenience RPC endpoints per network

## Specs

- [Locksmith OpenAPI 3.0 (this repo)](openapi/unlock-protocol-locksmith-openapi.yml): 120 operations, bearer JWT (Sign-In with Ethereum) + api-key auth
- [Locksmith OpenAPI (upstream)](https://raw.githubusercontent.com/unlock-protocol/unlock/master/packages/unlock-js/openapi.yml)

## Docs

- [Documentation home](https://docs.unlock-protocol.com/)
- [What is Unlock?](https://docs.unlock-protocol.com/getting-started/what-is-unlock/)
- [Sign-In with Ethereum (EIP-4361) auth](https://docs.unlock-protocol.com/tools/sign-in-with-ethereum/)
- [Webhooks (WebSub)](https://docs.unlock-protocol.com/tools/locksmith/webhooks)
- [Checkout + Paywall embeddable](https://docs.unlock-protocol.com/tools/checkout/paywall)
- [Hardhat plugin](https://docs.unlock-protocol.com/tools/hardhat-plugin)
- [unlock-js SDK](https://docs.unlock-protocol.com/tools/unlock.js)
- [Smart contract audits](https://docs.unlock-protocol.com/core-protocol/audits)
- [DAO roadmap](https://docs.unlock-protocol.com/governance/roadmap)

## SDKs

- [@unlock-protocol/unlock-js](https://www.npmjs.com/package/@unlock-protocol/unlock-js): JavaScript SDK (LocksmithService + contract services)
- [@unlock-protocol/paywall](https://www.npmjs.com/package/@unlock-protocol/paywall): embeddable paywall/checkout
- [@unlock-protocol/contracts](https://www.npmjs.com/package/@unlock-protocol/contracts): contract ABIs
- [@unlock-protocol/networks](https://www.npmjs.com/package/@unlock-protocol/networks): deployed contract addresses
- [@unlock-protocol/hardhat-plugin](https://www.npmjs.com/package/@unlock-protocol/hardhat-plugin): local development

## Optional

- [GitHub organization](https://github.com/unlock-protocol)
- [Blog](https://unlock-protocol.com/blog)
- [Guides](https://unlock-protocol.com/guides)
- [Terms](https://unlock-protocol.com/terms)
- [Privacy](https://unlock-protocol.com/privacy)