Unlock Protocol · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Unlock Locksmith

5 actions 5 updates update extends openapi/unlock-protocol-locksmith-openapi.yml
Derived by API Evangelist Built from the contracts Unlock Protocol publishes. Unlock Protocol did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-notex-apievangelistx-apievangelist-artifactsx-audiences

Targets 4

$.info
$.servers
$.paths['/v2/api/{network}/locks/{lockAddress}/keys'].get
$.components.securitySchemes.User

OpenAPI Overlay

Raw ↑
# API Evangelist enhancement overlay — never mutates the harvested spec.
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Unlock Locksmith
  version: 1.0.0
x-generated: '2026-07-21'
x-method: generated
extends: openapi/unlock-protocol-locksmith-openapi.yml
actions:
  - target: $.info
    update:
      x-apievangelist:
        provider: unlock-protocol
        enriched: '2026-07-21'
        notes: >-
          Locksmith is Unlock Protocol's hosted convenience API (metadata storage, ticketing,
          fiat payments via Stripe Connect, webhooks, emails, QR codes). It complements — and can
          be replaced by — direct use of the Unlock smart contracts and subgraphs.
      x-apievangelist-artifacts:
        authentication: authentication/unlock-protocol-authentication.yml
        errors: errors/unlock-protocol-problem-types.yml
        conventions: conventions/unlock-protocol-conventions.yml
        webhooks: asyncapi/unlock-protocol-websub-webhooks.yml
        data-model: data-model/unlock-protocol-data-model.yml
  - target: $.info
    update:
      x-audiences:
        - membership-platform-developers
        - event-ticketing-integrators
        - token-gating-implementers
  - target: $.servers
    description: Production and staging servers are both published; staging doubles as the sandbox.
    update: []
  - target: $.paths['/v2/api/{network}/locks/{lockAddress}/keys'].get
    update:
      x-apievangelist-note: Deprecated by the provider in favor of keysByPage (keys-by-page).
  - target: $.components.securitySchemes.User
    update:
      x-apievangelist-note: >-
        Bearer JWT obtained via a Sign-In with Ethereum (EIP-4361) login flow (nonce + login
        operations); short-lived access token with a refresh token for renewal.

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/unlock-protocol-locksmith-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.