https://github.com/neynarxyz/oas

The OpenAPI specification for the Neynar APIs
https://github.com/neynarxyz/oas

farcaster neynar openapi-specification rest-api

Last synced: 7 days ago
JSON representation

The OpenAPI specification for the Neynar APIs

• Host: GitHub
• URL: https://github.com/neynarxyz/oas
• Owner: neynarxyz
• License: mit
• Created: 2023-10-18T15:42:40.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-01T02:26:59.000Z (about 2 months ago)
• Last Synced: 2024-10-01T06:44:47.284Z (about 2 months ago)
• Topics: farcaster, neynar, openapi-specification, rest-api
• Homepage: https://neynar.com
• Size: 546 KB
• Stars: 14
• Watchers: 5
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OAS

The OpenAPI specification for the [Neynar](https://neynar.com) [APIs](https://docs.neynar.com)

### Installation

Prerequisite

- JAVA must be installed

replace \ with a [desired generator](https://openapi-generator.tech/docs/generators).

```

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](https://docs.neynar.com/)

### Clients library that use this specs

[farcaster-js](https://github.com/standard-crypto/farcaster-js/)

### How to get an API key?

Get more information at [neynar.com](https://neynar.com/)