Providers | OpenRouter TypeScript SDK | OpenRouter

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Overview

Provider information endpoints

Available Operations

list - List all providers

list

List all providers

Example Usage

1 import { OpenRouter } from "@openrouter/sdk";
2 
3 const openRouter = new OpenRouter({
4   apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
5 });
6 
7 async function run() {
8   const result = await openRouter.providers.list();
9 
10   console.log(result);
11 }
12 
13 run();

Standalone function

The standalone function version of this method:

1 import { OpenRouterCore } from "@openrouter/sdk/core.js";
2 import { providersList } from "@openrouter/sdk/funcs/providersList.js";
3 
4 // Use `OpenRouterCore` for best tree-shaking performance.
5 // You can create one instance of it to use across an application.
6 const openRouter = new OpenRouterCore({
7   apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
8 });
9 
10 async function run() {
11   const res = await providersList(openRouter);
12   if (res.ok) {
13     const { value: result } = res;
14     console.log(result);
15   } else {
16     console.log("providersList failed:", res.error);
17   }
18 }
19 
20 run();

Parameters

Parameter	Type	Required	Description
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ListProvidersResponse>

Errors

Error Type	Status Code	Content Type
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

1	import { OpenRouter } from "@openrouter/sdk";
2
3	const openRouter = new OpenRouter({
4	apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
5	});
6
7	async function run() {
8	const result = await openRouter.providers.list();
9
10	console.log(result);
11	}
12
13	run();

1	import { OpenRouterCore } from "@openrouter/sdk/core.js";
2	import { providersList } from "@openrouter/sdk/funcs/providersList.js";
3
4	// Use `OpenRouterCore` for best tree-shaking performance.
5	// You can create one instance of it to use across an application.
6	const openRouter = new OpenRouterCore({
7	apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
8	});
9
10	async function run() {
11	const res = await providersList(openRouter);
12	if (res.ok) {
13	const { value: result } = res;
14	console.log(result);
15	} else {
16	console.log("providersList failed:", res.error);
17	}
18	}
19
20	run();