Typesafe APIs Made Simple

oRPC is a powerful combination of RPC and OpenAPI, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards

Highlights

• End-to-End Type Safety: Ensure type-safe inputs, outputs, and errors from client to server.
• First-Class OpenAPI: Built-in support that fully adheres to the OpenAPI standard.
• Contract-First Development: Optionally define your API contract before implementation.
• First-Class OpenTelemetry: Seamlessly integrate with OpenTelemetry for observability.
• Framework Integrations: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
• Server Actions: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
• Standard Schema Support: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
• Native Types: Supports native types like Date, File, Blob, BigInt, URL, and more.
• Lazy Router: Enhance cold start times with our lazy routing feature.
• SSE & Streaming: Enjoy full type-safe support for SSE and streaming.
• Multi-Runtime Support: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
• Extendability: Easily extend functionality with plugins, middleware, and interceptors.

Documentation

You can find the full documentation here.

Packages

• @orpc/contract: Build your API contract.
• @orpc/server: Build your API or implement API contract.
• @orpc/client: Consume your API on the client with type-safety.
• @orpc/openapi: Generate OpenAPI specs and handle OpenAPI requests.
• @orpc/otel: OpenTelemetry integration for observability.
• @orpc/nest: Deeply integrate oRPC with NestJS.
• @orpc/react: Utilities for integrating oRPC with React and React Server Actions.
• @orpc/tanstack-query: TanStack Query integration.
• @orpc/experimental-react-swr: SWR integration.
• @orpc/vue-colada: Integration with Pinia Colada.
• @orpc/hey-api: Hey API integration.
• @orpc/zod: More schemas that Zod doesn't support yet.
• @orpc/valibot: OpenAPI spec generation from Valibot.
• @orpc/arktype: OpenAPI spec generation from ArkType.

@orpc/client

Consume your API on the client with type-safety. Read the documentation for more information.

import { createORPCClient } from '@orpc/client'
import { RPCLink } from '@orpc/client/fetch'
import { ContractRouterClient } from '@orpc/contract'
import { RouterClient } from '@orpc/server'

const link = new RPCLink({
  url: 'http://localhost:3000/rpc',
  headers: () => ({
    authorization: 'Bearer token',
  }),
  // fetch: <-- provide fetch polyfill fetch if needed
})

// Create a client for your router
const client: RouterClient<typeof router> = createORPCClient(link)
// Or, create a client using a contract
const client: ContractRouterClient<typeof contract> = createORPCClient(link)

Sponsors

If you find oRPC valuable and would like to support its development, you can do so here: GitHub Sponsors.

License

Distributed under the MIT License. See LICENSE for more information.