Overview

Welcome to the Memory Protocol API—a suite of endpoints designed to help you retrieve and link user identities across Web3 and social platforms. If you’re looking for a high-level explanation of Memory Protocol’s features and goals, please refer to our main Introduction page.

OpenAPI Specification

We use an OpenAPI (3.1) file to document the Memory Protocol API. This specification includes endpoint definitions, parameters, request/response examples, and authentication requirements.

Key details from the spec:

  • Title: Memory API (v1.0.0)
  • Description: Generated from our OpenAPI specification
  • Server: https://api.memoryproto.co
  • Authentication: Bearer token
  • Primary Endpoints:
    • /query/wallet/{address}
    • /query/farcaster/username/{username}
    • /query/farcaster/fid/{fid}

To learn more, or to integrate this spec into your own tooling, visit the link below.

Memory Protocol Endpoints

View the OpenAPI specification file

Authentication

All endpoints require a Bearer token for authentication. You can register for an API key at the Memory developer dashboard. Once you have your token:

  1. Include it in an Authorization header as Bearer <your_token>.
  2. Make requests to any of the /query/... endpoints documented in our spec.