PRODUCT — PLATFORM

TypeScript SDK

SDK

A fully typed client generated from our OpenAPI spec: every endpoint, parameter, and response checked at compile time.

Types that can't drift from the API

The SDK is generated from the OpenAPI 3.1 spec that documents the API. Every endpoint, parameter, and response body is typed, and the types regenerate when the spec changes. The client can't silently fall behind the API.

Install @ryxel-ai/findata from npm, configure the client with your API key, and call typed functions. Autocomplete lists the real parameters; the compiler rejects the wrong ones.

Optional React Query helpers ship in the box for teams building internal tools on @tanstack/react-query. Keep the SDK server-side: API routes, backend proxies, and server components. Browser code would expose your key.

What you get

Package
@ryxel-ai/findata on npm
Generated from
The public OpenAPI 3.1 spec
Client
@hey-api/client-fetch
Extras
React Query options factories
Environment
Server-side only

Why teams use it

Types end to end

Query parameters and response bodies are typed from the OpenAPI spec, so autocomplete and the compiler catch mistakes before production does.

Generated, never stale

The SDK is built from the same spec that documents the API. When an endpoint changes, the types change with it.

Optional React Query helpers

Options factories for @tanstack/react-query ship in the box for server components, API routes, and internal tools.

Server-side ready

Drop the client into a Next.js route, a backend proxy, or a worker. Your API key stays off public frontends.

See it in code

setup.ts
typescript
# pnpm add @ryxel-ai/findata @hey-api/client-fetch

import { client } from "@ryxel-ai/findata/client";
import { getInsiderTransactions } from "@ryxel-ai/findata/sdk";

client.setConfig({
  baseUrl: "https://ryxel.io/api",
  headers: { "x-api-key": "YOUR_API_KEY" },
});

const { data } = await getInsiderTransactions({
  query: { ticker: "TSLA", limit: 50 },
});

What teams build with it

API routes and backends

Call typed functions from Next.js routes, Express handlers, or workers. Bad parameters fail at compile time, not in production.

Internal tools with React Query

The options factories plug straight into useQuery, so dashboards and admin tools get caching and refetching for free.

Scripts and pipelines

A typed client in a cron script reads like pseudocode and fails loudly when a field changes.

Type-safe agent tools

Wrap SDK calls as agent tools with typed arguments, so an LLM can only ask for parameters that actually exist.

Frequently asked questions

What is the SDK package name?

The SDK is published as @ryxel-ai/findata on npm. Install it with pnpm add @ryxel-ai/findata @hey-api/client-fetch.

Can I use the SDK in browser code?

No. Embedding your API key in public frontend code exposes it. Use the SDK server-side: API routes, a backend proxy, or React Server Components.

Does the SDK support React Query?

Yes. Import options factories from @ryxel-ai/findata/react-query and they plug straight into useQuery.

How do types stay in sync with the API?

The SDK is generated from the same OpenAPI 3.1 spec that documents the API. When the spec changes, the client regenerates, so type errors surface at build time instead of runtime.

TALK TO US

Talk to us about access

Tell us what you're building and which datasets you need — we'll set you up with an account, an API key, and access to the data.