Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neynar Storage API

Operations related to storage

This API exposes 4 operations across 4 paths, and defines 16 schemas. It is described by OpenAPI 3.0.4, at version 3.176.0.

Requests are made against a single base URL, https://api.neynar.com.

4 operations 4 paths 16 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
3.176.0
Base URL
https://api.neynar.com
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Neynar Storage API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key to authorize requests

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Storage 4

Operations related to storage

GET
/v2/farcaster/storage/allocations/
Allocation of user
lookup-user-storage-allocations 1 param → 200400
POST
/v2/farcaster/storage/buy/
Buy storage
buy-storage 1 param body → 200400409500
GET
/v2/farcaster/storage/usage/
Usage of user
lookup-user-storage-usage 1 param → 200400
GET
/v1/storageLimitsByFid
FID's limits
lookup-user-storage-limit 1 param → 200default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are StorageUsageResponse (9 properties), UserDehydrated (7 properties), ErrorResponse (6 properties), StorageAllocation (5 properties). Each schema is shown below with its type and property counts.

StorageAllocation
object
5 properties
StorageObject
object
3 properties
StorageLimit
object
2 properties 2 required
ConflictErrorRes
object
Details for the conflict error response
4 properties 1 required
ErrorResponse
object
6 properties 6 required
EthAddress
string
Ethereum address
StorageLimitsResponse
object
4 properties 3 required
Idem
string
An Idempotency key is a unique identifier for the request. Note: 1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) Thi…
ZodError
object
3 properties 3 required
StoreType
string
StorageUsageResponse
object
9 properties
UserDehydrated
object
7 properties 2 required
ErrorRes
object
Details for the error response
4 properties 1 required
BuyStorageReqBody
object
3 properties 1 required
StorageAllocationsResponse
object
2 properties
Fid
integer
The unique identifier of a farcaster user or app (unsigned integer)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neynar-storage-api-openapi.yml Raw ↑