Skip to content

neynarxyz/OAS

Repository files navigation

OAS

The OpenAPI specification for the Neynar APIs

Installation

Prerequisite

  • JAVA must be installed

replace <generator> with a desired generator.

brew install openapi-generator

// v1

openapi-generator generate -i src/v1/spec.yaml -g typescript-axios -o src/v1/swagger-tmp --config openapi-generator-config.json

// v2

openapi-generator generate -i src/v2/spec.yaml -g typescript-axios -o src/v2/swagger-tmp --config openapi-generator-config.json

// stp

openapi-generator generate -i src/v2/stp/spec.yaml -g typescript-axios -o src/v2/swagger-tmp --config openapi-generator-config.json

// hub-rest-api

openapi-generator generate -i src/hub-rest-api/spec.yaml -g typescript-axios -o src/hub-rest-api/swagger-tmp --config openapi-generator-config.json

API Documentation

docs.neynar.com

Clients library that use this specs

farcaster-js

How to get an API key?

Get more information at neynar.com