ListData Type | OpenRouter TypeScript SDK | OpenRouter

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

Example Usage

1 import { ListData } from "@openrouter/sdk/models/operations";
2 
3 let value: ListData = {
4   byokUsage: 17.38,
5   byokUsageDaily: 17.38,
6   byokUsageMonthly: 17.38,
7   byokUsageWeekly: 17.38,
8   createdAt: "2025-08-24T10:30:00Z",
9   creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000",
10   disabled: false,
11   hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
12   includeByokInLimit: false,
13   label: "sk-or-v1-0e6...1c96",
14   limit: 100,
15   limitRemaining: 74.5,
16   limitReset: "monthly",
17   name: "My Production Key",
18   updatedAt: "2025-08-24T15:45:00Z",
19   usage: 25.5,
20   usageDaily: 25.5,
21   usageMonthly: 25.5,
22   usageWeekly: 25.5,
23 };

Fields

Field	Type	Required	Description	Example
`byokUsage`	number	✔️	Total external BYOK usage (in USD) for the API key	17.38
`byokUsageDaily`	number	✔️	External BYOK usage (in USD) for the current UTC day	17.38
`byokUsageMonthly`	number	✔️	External BYOK usage (in USD) for current UTC month	17.38
`byokUsageWeekly`	number	✔️	External BYOK usage (in USD) for the current UTC week (Monday-Sunday)	17.38
`createdAt`	string	✔️	ISO 8601 timestamp of when the API key was created	2025-08-24T10:30:00Z
`creatorUserId`	string	✔️	The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user’s own ID.	user_2dHFtVWx2n56w6HkM0000000000
`disabled`	boolean	✔️	Whether the API key is disabled	false
`expiresAt`	Date	➖	ISO 8601 UTC timestamp when the API key expires, or null if no expiration	2027-12-31T23:59:59Z
`hash`	string	✔️	Unique hash identifier for the API key	f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
`includeByokInLimit`	boolean	✔️	Whether to include external BYOK usage in the credit limit	false
`label`	string	✔️	Human-readable label for the API key	sk-or-v1-0e6…1c96
`limit`	number	✔️	Spending limit for the API key in USD	100
`limitRemaining`	number	✔️	Remaining spending limit in USD	74.5
`limitReset`	string	✔️	Type of limit reset for the API key	monthly
`name`	string	✔️	Name of the API key	My Production Key
`updatedAt`	string	✔️	ISO 8601 timestamp of when the API key was last updated	2025-08-24T15:45:00Z
`usage`	number	✔️	Total OpenRouter credit usage (in USD) for the API key	25.5
`usageDaily`	number	✔️	OpenRouter credit usage (in USD) for the current UTC day	25.5
`usageMonthly`	number	✔️	OpenRouter credit usage (in USD) for the current UTC month	25.5
`usageWeekly`	number	✔️	OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday)	25.5