Skip to content

neynarxyz/nodejs-sdk

Repository files navigation

@neynar/nodejs-sdk

@neynar/nodejs-sdk typescript-based, easy-to-use SDK built to interact with Neynar API's.

Usage

Please refer to our Getting Started Guide

Checkout examples using this SDK

Type Definitions

You can directly import the type definitions from the SDK as shown below:

  • See your node_modules/@neynar/nodejs-sdk/build/neynar-api/v2/openapi-farcaster directory for the type definitions.
import { type User } from '@neynar/nodejs-sdk/build/neynar-api/v2/openapi-farcaster/models/user'
import { type CastAuthor } from '@neynar/nodejs-sdk/build/neynar-api/v2/openapi-farcaster/models/cast-author'
import { type CastWithInteractionsReactions } from '@neynar/nodejs-sdk/build/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-reactions'

Contribution Guidelines

see CONTRIBUTING.md.

License

This project is licensed under the MIT License. This license permits free use, modification, and distribution of the software, with the requirement that the original copyright and license notice are included in any substantial portion of the work. - see the LICENSE file for details.