NEAR JSON-RPC TypeScript SDK

A modern, type-safe TypeScript SDK for NEAR Protocol's JSON-RPC API.

Packages

Package	Description
@near-js/jsonrpc-client	Type-safe JSON-RPC client
@near-js/jsonrpc-types	TypeScript types and schemas
@near-js/jsonrpc-react-query	React Query hooks for NEAR JSON-RPC
@near-js/jsonrpc-generator	Code generator for types (Detailed docs)

Quick Start

npm install @near-js/jsonrpc-client

import { jsonRpcTransporter, createClient } from "@near-js/jsonrpc-client";

const transporter = jsonRpcTransporter({
  endpoint: "https://rpc.testnet.near.org",
});
const client = createClient({ transporter });

// Query account
const account = await client.query({
  requestType: "view_account",
  finality: "final",
  accountId: "example.testnet",
});

console.log(`Balance: ${account.result.amount} yoctoNEAR`);

Links

• Examples - Usage examples
• Generator Documentation - Detailed guide on how the type generator works
• NEAR Docs - JSON-RPC API reference

Development

git clone https://github.com/near/near-jsonrpc.git
cd near-jsonrpc
yarn install
yarn build

Contributing

We welcome contributions! Please see our Contributing Guide for details on:

• Setting up the development environment
• Understanding the project architecture
• Making and submitting changes
• Release process

License

MIT