@invinite-org/invinite-data-cli 4.0.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -21
- package/claude-plugin/.claude-plugin/plugin.json +1 -1
- package/claude-plugin/agents/invinite-data.md +1 -1
- package/claude-plugin/skills/invinite-data-cli/SKILL.md +11 -11
- package/dist/src/cli.js +1 -1
- package/dist/src/client/api-client.d.ts +1 -1
- package/dist/src/commands/api.d.ts +1 -1
- package/dist/src/commands/api.js +7 -7
- package/dist/src/commands/auth.d.ts +1 -1
- package/dist/src/commands/auth.js +3 -3
- package/dist/src/generated/cli-manifest.json +88 -88
- package/dist/src/spec-commands.js +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,7 +13,9 @@ invd holdings AAPL
|
|
|
13
13
|
invd search filings "supply chain risk" --company AAPL
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Version
|
|
16
|
+
Version 5.0 calls the API at its final `/v1` paths (the 2026-11-11 cut-over moved the redesigned API from `/v2` to
|
|
17
|
+
`/v1` and deleted the old v1); its commands are the 4.0 commands. Coming from 4.x, read
|
|
18
|
+
[Upgrading from 4.x](#upgrading-from-4x); from 3.x, [Upgrading from 3.x](#upgrading-from-3x).
|
|
17
19
|
|
|
18
20
|
## Installation
|
|
19
21
|
|
|
@@ -58,7 +60,7 @@ The active key is resolved in this order:
|
|
|
58
60
|
5. `api_key` in the global `config.toml`
|
|
59
61
|
|
|
60
62
|
```bash
|
|
61
|
-
curl -H "Authorization: Bearer $(invd auth token)" https://api.data.invinite.com/
|
|
63
|
+
curl -H "Authorization: Bearer $(invd auth token)" https://api.data.invinite.com/v1/me
|
|
62
64
|
```
|
|
63
65
|
|
|
64
66
|
## The command grammar
|
|
@@ -110,7 +112,7 @@ invd events transcript <event_id>
|
|
|
110
112
|
and `invd events AAPL` lists Apple's calls.
|
|
111
113
|
|
|
112
114
|
**Events by fiscal period.** Every command that takes an `event_id` also takes a company and a fiscal period in its
|
|
113
|
-
place; invd resolves the event through `GET /
|
|
115
|
+
place; invd resolves the event through `GET /v1/events` and says so on stderr:
|
|
114
116
|
|
|
115
117
|
```bash
|
|
116
118
|
invd events transcript NVDA 2026Q3
|
|
@@ -327,12 +329,12 @@ invd investor-documents get <document_id> --save report.pdf
|
|
|
327
329
|
The escape hatch for anything the command tree lacks:
|
|
328
330
|
|
|
329
331
|
```bash
|
|
330
|
-
invd api /
|
|
331
|
-
invd api GET /
|
|
332
|
-
invd api GET /
|
|
333
|
-
invd api POST /
|
|
334
|
-
invd api DELETE /
|
|
335
|
-
invd api GET /
|
|
332
|
+
invd api /v1/companies/AAPL
|
|
333
|
+
invd api GET /v1/filings?company=AAPL --paginate --jq '.data[].accession'
|
|
334
|
+
invd api GET /v1/holdings -F company=AAPL -F limit=100
|
|
335
|
+
invd api POST /v1/webhooks --input webhook.json
|
|
336
|
+
invd api DELETE /v1/webhooks/<id> --yes
|
|
337
|
+
invd api GET /v1/me -H 'Accept: application/json' --dry-run
|
|
336
338
|
```
|
|
337
339
|
|
|
338
340
|
`-F key=value` is typed (numbers, `true` / `false`, `null`, `@file`), `-f key=value` always a string; both are query
|
|
@@ -418,7 +420,7 @@ invd completion bash > ~/.local/share/bash-completion/completions/invd
|
|
|
418
420
|
invd completion fish > ~/.config/fish/completions/invd.fish
|
|
419
421
|
```
|
|
420
422
|
|
|
421
|
-
Completion covers commands, flags, and the `/
|
|
423
|
+
Completion covers commands, flags, and the `/v1` paths after `invd api`.
|
|
422
424
|
|
|
423
425
|
## Exit codes
|
|
424
426
|
|
|
@@ -432,9 +434,15 @@ Completion covers commands, flags, and the `/v2` paths after `invd api`.
|
|
|
432
434
|
| 5 | integrity: a download's checksum or size does not match |
|
|
433
435
|
| 6 | credits exhausted or plan required: 402, `plan_required`, `insufficient_credits` |
|
|
434
436
|
|
|
437
|
+
## Upgrading from 4.x
|
|
438
|
+
|
|
439
|
+
5.0 keeps every 4.x command, flag, output and exit code; only the request paths moved from `/v2/...` to `/v1/...`
|
|
440
|
+
(the API's 2026-11-11 cut-over; `/v2/*` answers 404 since, so 4.x no longer works). `invd api` paths are `/v1/...`
|
|
441
|
+
now. Upgrade = install 5.0.
|
|
442
|
+
|
|
435
443
|
## Upgrading from 3.x
|
|
436
444
|
|
|
437
|
-
4.0
|
|
445
|
+
4.0 replaced the old v1 command tree with the noun-verb grammar (5.0 keeps it). No 3.x spelling is kept as an alias.
|
|
438
446
|
|
|
439
447
|
| 3.x | 4.0 |
|
|
440
448
|
|---|---|
|
|
@@ -451,21 +459,15 @@ Completion covers commands, flags, and the `/v2` paths after `invd api`.
|
|
|
451
459
|
| `sec filings\|filing\|document\|sections\|search` | `invd filings list\|get`, `invd documents get\|sections`, `invd search filings` |
|
|
452
460
|
| `ownership …` | `invd holdings list\|changes` |
|
|
453
461
|
| `usage` | `invd me usage` |
|
|
454
|
-
| `ws listen` (WebSocket stream) | no CLI command in 4.0; use the API's `/
|
|
462
|
+
| `ws listen` (WebSocket stream) | no CLI command in 4.0; use the API's `/v1/stream` |
|
|
455
463
|
| `-i, --identifier AAPL` | the positional company: `invd filings AAPL` |
|
|
456
464
|
| `--offset <n>` | `--cursor <next_cursor>` |
|
|
457
465
|
| `INVINITE_DATA_API_KEY` | still read; `INVD_API_KEY` takes precedence |
|
|
458
466
|
|
|
459
|
-
###
|
|
460
|
-
|
|
461
|
-
invd 3.x is the CLI of the v1 API and stays installable:
|
|
462
|
-
|
|
463
|
-
```bash
|
|
464
|
-
npm install -g @invinite-org/invinite-data-cli@3
|
|
465
|
-
```
|
|
467
|
+
### Older majors
|
|
466
468
|
|
|
467
|
-
|
|
468
|
-
|
|
469
|
+
invd 3.x (the old v1 API) and 4.x (the `/v2` paths) call routes that were deleted on 2026-11-11; neither works
|
|
470
|
+
against the live API any more. Install 5.x.
|
|
469
471
|
|
|
470
472
|
## Development
|
|
471
473
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "invinite-financial-data",
|
|
3
3
|
"description": "Fetch and analyze financial data using the Invinite Data API — company fundamentals, financial statements, SEC filings, earnings calls (transcripts, guidance, Q&A, live calls), company news, institutional ownership, insider trades, and more.",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.6.0",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Invinite"
|
|
7
7
|
},
|
|
@@ -44,7 +44,7 @@ the `invd` CLI (version 4, the v2 API) and return it in a clean, structured form
|
|
|
44
44
|
- Exit 4 = no or invalid key: report it and tell the caller to run `invd auth login` (or set `INVD_API_KEY`).
|
|
45
45
|
Exit 6 = credits exhausted or plan required: report the plan or credit message as given.
|
|
46
46
|
- Never pass `--save` unless the caller asked for a file.
|
|
47
|
-
- When the command tree lacks an operation, `invd api GET /
|
|
47
|
+
- When the command tree lacks an operation, `invd api GET /v1/<path>` reaches it (it prints JSON).
|
|
48
48
|
|
|
49
49
|
## MCP equivalents
|
|
50
50
|
|
|
@@ -39,7 +39,7 @@ serves the earlier roster; use whatever tools it lists, or the CLI.
|
|
|
39
39
|
| News items, text, announcements, news search | `get_news` | `invd news list\|get\|text\|announcements`, `invd search news` |
|
|
40
40
|
| Account and usage | `get_account` | `invd me show\|usage` |
|
|
41
41
|
| Webhooks | `manage_webhooks` | `invd webhooks …` |
|
|
42
|
-
| Any other operation | `search_endpoints` + `call_api` | `invd api GET /
|
|
42
|
+
| Any other operation | `search_endpoints` + `call_api` | `invd api GET /v1/…` |
|
|
43
43
|
|
|
44
44
|
MCP resources `invinite://catalog/metrics`, `invinite://catalog/sections`, `invinite://catalog/event-types`,
|
|
45
45
|
`invinite://catalog/forms` and `invinite://catalog/document-kinds` are the catalogs (`invd catalog metrics`, `invd catalog sections`, `invd catalog event-types`, `invd catalog forms`,
|
|
@@ -74,10 +74,10 @@ An auth failure exits 4: reconnect the MCP connector, or tell the user to run `i
|
|
|
74
74
|
`invd financials AAPL MSFT`), the member id on member commands (`invd companies get AAPL`,
|
|
75
75
|
`invd filings get 0000320193-26-000026`, `invd events transcript <event_id>`).
|
|
76
76
|
- Every command that takes an `event_id` also takes a company plus a fiscal period: `invd events transcript NVDA 2026Q3`
|
|
77
|
-
resolves the event through `GET /
|
|
77
|
+
resolves the event through `GET /v1/events` (one extra credit; the resolution is noted on stderr).
|
|
78
78
|
- Flags are the API parameters with dashes (`fiscal_year` → `--fiscal-year`, `filed_at[gte]` → `--filed-at-gte`).
|
|
79
79
|
`invd <group> <action> --help` lists them with the API's descriptions, the credit cost and plan, and the row fields.
|
|
80
|
-
- `invd api` calls any path the tree lacks: `invd api GET /
|
|
80
|
+
- `invd api` calls any path the tree lacks: `invd api GET /v1/filings?company=AAPL --paginate --jq '.data[].accession'`.
|
|
81
81
|
|
|
82
82
|
## Output, pagination and cost
|
|
83
83
|
|
|
@@ -251,10 +251,10 @@ invd agent-setup --all --global --dry-run # print what would be written
|
|
|
251
251
|
|
|
252
252
|
<!-- invd:hand:api -->
|
|
253
253
|
```bash
|
|
254
|
-
invd api /
|
|
255
|
-
invd api GET /
|
|
256
|
-
invd api GET /
|
|
257
|
-
invd api POST /
|
|
254
|
+
invd api /v1/companies/AAPL
|
|
255
|
+
invd api GET /v1/filings?company=AAPL --paginate --jq '.data[].accession'
|
|
256
|
+
invd api GET /v1/holdings -F company=AAPL -F limit=100 --dry-run
|
|
257
|
+
invd api POST /v1/webhooks --input webhook.json
|
|
258
258
|
```
|
|
259
259
|
<!-- /invd:hand:api -->
|
|
260
260
|
|
|
@@ -499,7 +499,7 @@ invd investor-documents list AAPL --json
|
|
|
499
499
|
|
|
500
500
|
### ipos
|
|
501
501
|
|
|
502
|
-
|
|
502
|
+
Offerings from registration to listing
|
|
503
503
|
|
|
504
504
|
```bash
|
|
505
505
|
# Get an offering (optional: --fields)
|
|
@@ -520,7 +520,7 @@ invd market holidays --json
|
|
|
520
520
|
|
|
521
521
|
### me
|
|
522
522
|
|
|
523
|
-
|
|
523
|
+
The caller's account and usage (0 credits)
|
|
524
524
|
|
|
525
525
|
```bash
|
|
526
526
|
# Who am I
|
|
@@ -550,7 +550,7 @@ invd metrics ratios AAPL -p annual --json
|
|
|
550
550
|
|
|
551
551
|
### news
|
|
552
552
|
|
|
553
|
-
News
|
|
553
|
+
News items, full text, search and announcements
|
|
554
554
|
|
|
555
555
|
```bash
|
|
556
556
|
# List announcements (optional: --topic, --item, --announced-at-gte, --announced-at-gt, --announced-at-lte, --announced-at-lt, --effective-from-gte, --effective-to-lte, --sort, --fields, --limit, --cursor, --all)
|
|
@@ -623,7 +623,7 @@ invd segments list-detailed AAPL -p annual --json
|
|
|
623
623
|
|
|
624
624
|
### webhooks
|
|
625
625
|
|
|
626
|
-
Outbound
|
|
626
|
+
Outbound event deliveries
|
|
627
627
|
|
|
628
628
|
```bash
|
|
629
629
|
# Create a webhook (optional: --idempotency-key, --url, --events, --ciks, --keywords, --body, --body-file)
|
package/dist/src/cli.js
CHANGED
|
@@ -65,7 +65,7 @@ export function createProgram() {
|
|
|
65
65
|
applyColorEnv();
|
|
66
66
|
program
|
|
67
67
|
.name('invd')
|
|
68
|
-
.description('CLI for the Invinite financial data API (
|
|
68
|
+
.description('CLI for the Invinite financial data API (v1)')
|
|
69
69
|
.version(packageVersion(), '-V, --version')
|
|
70
70
|
// Root options only before the subcommand: an operation's own `--version` (a transcript version) is its own.
|
|
71
71
|
.enablePositionalOptions()
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export type QueryValue = string | string[] | undefined;
|
|
2
2
|
export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
3
3
|
export interface RequestOptions {
|
|
4
|
-
/** A path under the base URL (`/
|
|
4
|
+
/** A path under the base URL (`/v1/filings`); a query string on it is kept. */
|
|
5
5
|
path: string;
|
|
6
6
|
method?: HttpMethod;
|
|
7
7
|
/** An array value is sent as a repeated parameter (`a=1&a=2`); `undefined` / `''` are dropped. */
|
|
@@ -20,7 +20,7 @@ interface ApiOpts {
|
|
|
20
20
|
export declare function apiRequestFrom(first: string, second: string | undefined, opts: ApiOpts): Promise<RequestOptions>;
|
|
21
21
|
/**
|
|
22
22
|
* `invd api`: any operation of the spec, raw. `--paginate` follows `next_cursor` / `Link rel="next"` and prints
|
|
23
|
-
* every page (each through `--jq`), so `invd api /
|
|
23
|
+
* every page (each through `--jq`), so `invd api /v1/filings?company=AAPL --paginate --jq '.data[].accession'`
|
|
24
24
|
* streams accessions.
|
|
25
25
|
*/
|
|
26
26
|
export declare function registerApiCommand(program: Command): void;
|
package/dist/src/commands/api.js
CHANGED
|
@@ -39,7 +39,7 @@ export function apiPathOf(rawPath, baseUrl = getBaseUrl()) {
|
|
|
39
39
|
throw new UsageError(`${rawPath} is not a URL or an API path`);
|
|
40
40
|
}
|
|
41
41
|
if (target.origin !== base.origin) {
|
|
42
|
-
throw new UsageError(`invd api only calls ${base.origin} (the request carries your API key); refusing ${target.origin}. Pass a path such as /
|
|
42
|
+
throw new UsageError(`invd api only calls ${base.origin} (the request carries your API key); refusing ${target.origin}. Pass a path such as /v1/companies/AAPL`);
|
|
43
43
|
}
|
|
44
44
|
const prefix = base.pathname.replace(/\/+$/, '');
|
|
45
45
|
const path = prefix && target.pathname.startsWith(`${prefix}/`) ? target.pathname.slice(prefix.length) : target.pathname;
|
|
@@ -60,7 +60,7 @@ export async function apiRequestFrom(first, second, opts) {
|
|
|
60
60
|
if (!METHODS.includes(method))
|
|
61
61
|
throw new UsageError(`${first} is not an HTTP method (${METHODS.join(', ')})`);
|
|
62
62
|
if (!rawPath)
|
|
63
|
-
throw new UsageError('invd api needs a path, e.g. invd api /
|
|
63
|
+
throw new UsageError('invd api needs a path, e.g. invd api /v1/companies/AAPL');
|
|
64
64
|
const url = new URL(apiPathOf(rawPath), 'http://placeholder');
|
|
65
65
|
const query = {};
|
|
66
66
|
url.searchParams.forEach((value, key) => { (query[key] ??= []).push(value); });
|
|
@@ -111,7 +111,7 @@ function print(body, jq) {
|
|
|
111
111
|
}
|
|
112
112
|
/**
|
|
113
113
|
* `invd api`: any operation of the spec, raw. `--paginate` follows `next_cursor` / `Link rel="next"` and prints
|
|
114
|
-
* every page (each through `--jq`), so `invd api /
|
|
114
|
+
* every page (each through `--jq`), so `invd api /v1/filings?company=AAPL --paginate --jq '.data[].accession'`
|
|
115
115
|
* streams accessions.
|
|
116
116
|
*/
|
|
117
117
|
export function registerApiCommand(program) {
|
|
@@ -119,7 +119,7 @@ export function registerApiCommand(program) {
|
|
|
119
119
|
.command('api')
|
|
120
120
|
.description('Call any API path directly (the escape hatch for anything the command tree lacks)')
|
|
121
121
|
.argument('<method-or-path>', 'GET (default), POST, PATCH, DELETE … or the path')
|
|
122
|
-
.argument('[path]', 'The path when a method is given, e.g. /
|
|
122
|
+
.argument('[path]', 'The path when a method is given, e.g. /v1/filings?company=AAPL')
|
|
123
123
|
.option('-F, --field <key=value>', 'A parameter (query on GET / DELETE, JSON body field otherwise); typed: numbers, true / false, null, @file', collect, [])
|
|
124
124
|
.option('-f, --raw-field <key=value>', 'Like -F, always a string', collect, [])
|
|
125
125
|
.option('-H, --header <name:value>', 'An extra request header', collect, [])
|
|
@@ -132,11 +132,11 @@ export function registerApiCommand(program) {
|
|
|
132
132
|
.option('--show-cost', 'Print the credits this command cost to stderr')
|
|
133
133
|
.addHelpText('before', [
|
|
134
134
|
'Examples:',
|
|
135
|
-
' $ invd api /
|
|
136
|
-
" $ invd api GET /
|
|
135
|
+
' $ invd api /v1/companies/AAPL',
|
|
136
|
+
" $ invd api GET /v1/filings?company=AAPL --paginate --jq '.data[].accession'",
|
|
137
137
|
'',
|
|
138
138
|
].join('\n'))
|
|
139
|
-
.addHelpText('after', '\nPaths: invd completion <shell> completes every /
|
|
139
|
+
.addHelpText('after', '\nPaths: invd completion <shell> completes every /v1 path of the spec after `invd api`.\n')
|
|
140
140
|
.action(withErrorHandling(async (first, second, _raw, command) => {
|
|
141
141
|
const opts = command.opts();
|
|
142
142
|
// commander keeps --input <file> and --no-input in one attribute: a string is the file, false the switch.
|
|
@@ -28,7 +28,7 @@ export declare function login(dependencies?: LoginDependencies, opts?: {
|
|
|
28
28
|
noBrowser?: boolean;
|
|
29
29
|
}): Promise<ExchangeData>;
|
|
30
30
|
export declare function logout(dependencies?: Pick<LoginDependencies, 'fetch'>): Promise<void>;
|
|
31
|
-
/** `invd auth status`: where the key comes from and, unless `offline`, what `GET /
|
|
31
|
+
/** `invd auth status`: where the key comes from and, unless `offline`, what `GET /v1/me` says about it (free). */
|
|
32
32
|
export declare function status(opts?: {
|
|
33
33
|
offline?: boolean;
|
|
34
34
|
json?: boolean;
|
|
@@ -263,7 +263,7 @@ export async function logout(dependencies = defaultDependencies) {
|
|
|
263
263
|
await clearApiKey();
|
|
264
264
|
console.log(chalk.green('Logged out locally.'));
|
|
265
265
|
}
|
|
266
|
-
/** `invd auth status`: where the key comes from and, unless `offline`, what `GET /
|
|
266
|
+
/** `invd auth status`: where the key comes from and, unless `offline`, what `GET /v1/me` says about it (free). */
|
|
267
267
|
export async function status(opts = {}) {
|
|
268
268
|
const resolved = await resolveApiKey();
|
|
269
269
|
const summary = {
|
|
@@ -273,7 +273,7 @@ export async function status(opts = {}) {
|
|
|
273
273
|
origin: resolved.origin,
|
|
274
274
|
};
|
|
275
275
|
if (!opts.offline) {
|
|
276
|
-
const { body } = await apiCall({ path: '/
|
|
276
|
+
const { body } = await apiCall({ path: '/v1/me', silent: true });
|
|
277
277
|
const account = body?.account;
|
|
278
278
|
const plan = body?.plan;
|
|
279
279
|
if (typeof account === 'object' && account !== null) {
|
|
@@ -315,7 +315,7 @@ export function registerAuthCommands(program) {
|
|
|
315
315
|
}));
|
|
316
316
|
auth
|
|
317
317
|
.command('status')
|
|
318
|
-
.description('Show which key is active, where it comes from, and the account it belongs to (GET /
|
|
318
|
+
.description('Show which key is active, where it comes from, and the account it belongs to (GET /v1/me, free)')
|
|
319
319
|
.option('--offline', 'Do not call the API')
|
|
320
320
|
.option('--json', 'Print JSON')
|
|
321
321
|
.addHelpText('before', 'Examples:\n $ invd auth status\n $ invd auth status --offline --json\n')
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"specVersion": "
|
|
3
|
-
"specSha256": "
|
|
2
|
+
"specVersion": "2026-11-11",
|
|
3
|
+
"specSha256": "e36d0409b4df860d4ebb0c8c1dbd4e6b8c45e232037db027b0a3d862804ebe84",
|
|
4
4
|
"groups": [
|
|
5
5
|
{
|
|
6
6
|
"name": "catalog",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
},
|
|
49
49
|
{
|
|
50
50
|
"name": "ipos",
|
|
51
|
-
"description": "
|
|
51
|
+
"description": "Offerings from registration to listing"
|
|
52
52
|
},
|
|
53
53
|
{
|
|
54
54
|
"name": "market",
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
},
|
|
57
57
|
{
|
|
58
58
|
"name": "me",
|
|
59
|
-
"description": "
|
|
59
|
+
"description": "The caller's account and usage (0 credits)"
|
|
60
60
|
},
|
|
61
61
|
{
|
|
62
62
|
"name": "metrics",
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
},
|
|
65
65
|
{
|
|
66
66
|
"name": "news",
|
|
67
|
-
"description": "News
|
|
67
|
+
"description": "News items, full text, search and announcements"
|
|
68
68
|
},
|
|
69
69
|
{
|
|
70
70
|
"name": "people",
|
|
@@ -80,7 +80,7 @@
|
|
|
80
80
|
},
|
|
81
81
|
{
|
|
82
82
|
"name": "webhooks",
|
|
83
|
-
"description": "Outbound
|
|
83
|
+
"description": "Outbound event deliveries"
|
|
84
84
|
}
|
|
85
85
|
],
|
|
86
86
|
"operations": [
|
|
@@ -89,7 +89,7 @@
|
|
|
89
89
|
"group": "catalog",
|
|
90
90
|
"action": "document-kinds",
|
|
91
91
|
"method": "get",
|
|
92
|
-
"path": "/
|
|
92
|
+
"path": "/v1/catalog/document-kinds",
|
|
93
93
|
"auth": true,
|
|
94
94
|
"summary": "List investor-document kinds",
|
|
95
95
|
"credits": 1,
|
|
@@ -143,7 +143,7 @@
|
|
|
143
143
|
"group": "catalog",
|
|
144
144
|
"action": "event-types",
|
|
145
145
|
"method": "get",
|
|
146
|
-
"path": "/
|
|
146
|
+
"path": "/v1/catalog/event-types",
|
|
147
147
|
"auth": true,
|
|
148
148
|
"summary": "List event types",
|
|
149
149
|
"credits": 1,
|
|
@@ -196,7 +196,7 @@
|
|
|
196
196
|
"group": "catalog",
|
|
197
197
|
"action": "forms",
|
|
198
198
|
"method": "get",
|
|
199
|
-
"path": "/
|
|
199
|
+
"path": "/v1/catalog/forms",
|
|
200
200
|
"auth": true,
|
|
201
201
|
"summary": "List SEC forms",
|
|
202
202
|
"credits": 1,
|
|
@@ -249,7 +249,7 @@
|
|
|
249
249
|
"group": "catalog",
|
|
250
250
|
"action": "mapping-rules",
|
|
251
251
|
"method": "get",
|
|
252
|
-
"path": "/
|
|
252
|
+
"path": "/v1/catalog/mapping-rules",
|
|
253
253
|
"auth": true,
|
|
254
254
|
"summary": "List standardized mapping rules",
|
|
255
255
|
"credits": 1,
|
|
@@ -323,7 +323,7 @@
|
|
|
323
323
|
"group": "catalog",
|
|
324
324
|
"action": "metrics",
|
|
325
325
|
"method": "get",
|
|
326
|
-
"path": "/
|
|
326
|
+
"path": "/v1/catalog/metrics",
|
|
327
327
|
"auth": true,
|
|
328
328
|
"summary": "List standardized metrics",
|
|
329
329
|
"credits": 1,
|
|
@@ -389,7 +389,7 @@
|
|
|
389
389
|
"group": "catalog",
|
|
390
390
|
"action": "sections",
|
|
391
391
|
"method": "get",
|
|
392
|
-
"path": "/
|
|
392
|
+
"path": "/v1/catalog/sections",
|
|
393
393
|
"auth": true,
|
|
394
394
|
"summary": "List filing section ids",
|
|
395
395
|
"credits": 1,
|
|
@@ -452,7 +452,7 @@
|
|
|
452
452
|
"group": "companies",
|
|
453
453
|
"action": "dividends",
|
|
454
454
|
"method": "get",
|
|
455
|
-
"path": "/
|
|
455
|
+
"path": "/v1/dividends",
|
|
456
456
|
"auth": true,
|
|
457
457
|
"summary": "List dividends",
|
|
458
458
|
"credits": 1,
|
|
@@ -577,7 +577,7 @@
|
|
|
577
577
|
"group": "companies",
|
|
578
578
|
"action": "fiscal-periods",
|
|
579
579
|
"method": "get",
|
|
580
|
-
"path": "/
|
|
580
|
+
"path": "/v1/fiscal-periods",
|
|
581
581
|
"auth": true,
|
|
582
582
|
"summary": "List fiscal periods",
|
|
583
583
|
"credits": 1,
|
|
@@ -663,7 +663,7 @@
|
|
|
663
663
|
"group": "companies",
|
|
664
664
|
"action": "get",
|
|
665
665
|
"method": "get",
|
|
666
|
-
"path": "/
|
|
666
|
+
"path": "/v1/companies/{company}",
|
|
667
667
|
"auth": true,
|
|
668
668
|
"summary": "Get a company",
|
|
669
669
|
"credits": 1,
|
|
@@ -757,7 +757,7 @@
|
|
|
757
757
|
"group": "companies",
|
|
758
758
|
"action": "list",
|
|
759
759
|
"method": "get",
|
|
760
|
-
"path": "/
|
|
760
|
+
"path": "/v1/companies",
|
|
761
761
|
"auth": true,
|
|
762
762
|
"summary": "List listed companies",
|
|
763
763
|
"credits": 1,
|
|
@@ -865,7 +865,7 @@
|
|
|
865
865
|
"group": "companies",
|
|
866
866
|
"action": "splits",
|
|
867
867
|
"method": "get",
|
|
868
|
-
"path": "/
|
|
868
|
+
"path": "/v1/splits",
|
|
869
869
|
"auth": true,
|
|
870
870
|
"summary": "List stock splits",
|
|
871
871
|
"credits": 1,
|
|
@@ -948,7 +948,7 @@
|
|
|
948
948
|
"group": "documents",
|
|
949
949
|
"action": "fact-places",
|
|
950
950
|
"method": "get",
|
|
951
|
-
"path": "/
|
|
951
|
+
"path": "/v1/fact-places",
|
|
952
952
|
"auth": true,
|
|
953
953
|
"summary": "List where facts appear in a document",
|
|
954
954
|
"credits": 1,
|
|
@@ -1039,7 +1039,7 @@
|
|
|
1039
1039
|
"group": "documents",
|
|
1040
1040
|
"action": "figure",
|
|
1041
1041
|
"method": "get",
|
|
1042
|
-
"path": "/
|
|
1042
|
+
"path": "/v1/document-versions/{version_id}/figures/{block_id}",
|
|
1043
1043
|
"auth": true,
|
|
1044
1044
|
"summary": "Get a figure",
|
|
1045
1045
|
"credits": 1,
|
|
@@ -1082,7 +1082,7 @@
|
|
|
1082
1082
|
"group": "documents",
|
|
1083
1083
|
"action": "get",
|
|
1084
1084
|
"method": "get",
|
|
1085
|
-
"path": "/
|
|
1085
|
+
"path": "/v1/document-versions/{version_id}",
|
|
1086
1086
|
"auth": true,
|
|
1087
1087
|
"summary": "Get a document version",
|
|
1088
1088
|
"credits": 1,
|
|
@@ -1171,7 +1171,7 @@
|
|
|
1171
1171
|
"group": "documents",
|
|
1172
1172
|
"action": "sections",
|
|
1173
1173
|
"method": "get",
|
|
1174
|
-
"path": "/
|
|
1174
|
+
"path": "/v1/document-versions/{version_id}/sections",
|
|
1175
1175
|
"auth": true,
|
|
1176
1176
|
"summary": "List a document version's sections",
|
|
1177
1177
|
"credits": 1,
|
|
@@ -1248,7 +1248,7 @@
|
|
|
1248
1248
|
"group": "events",
|
|
1249
1249
|
"action": "audio",
|
|
1250
1250
|
"method": "get",
|
|
1251
|
-
"path": "/
|
|
1251
|
+
"path": "/v1/events/{event_id}/audio",
|
|
1252
1252
|
"auth": true,
|
|
1253
1253
|
"summary": "Get an event's recording",
|
|
1254
1254
|
"credits": 5,
|
|
@@ -1285,7 +1285,7 @@
|
|
|
1285
1285
|
"group": "events",
|
|
1286
1286
|
"action": "comparison",
|
|
1287
1287
|
"method": "get",
|
|
1288
|
-
"path": "/
|
|
1288
|
+
"path": "/v1/events/{event_id}/comparison",
|
|
1289
1289
|
"auth": true,
|
|
1290
1290
|
"summary": "Compare an event with a prior one",
|
|
1291
1291
|
"credits": 1,
|
|
@@ -1336,7 +1336,7 @@
|
|
|
1336
1336
|
"group": "events",
|
|
1337
1337
|
"action": "get",
|
|
1338
1338
|
"method": "get",
|
|
1339
|
-
"path": "/
|
|
1339
|
+
"path": "/v1/events/{event_id}",
|
|
1340
1340
|
"auth": true,
|
|
1341
1341
|
"summary": "Get an event",
|
|
1342
1342
|
"credits": 1,
|
|
@@ -1421,7 +1421,7 @@
|
|
|
1421
1421
|
"group": "events",
|
|
1422
1422
|
"action": "list",
|
|
1423
1423
|
"method": "get",
|
|
1424
|
-
"path": "/
|
|
1424
|
+
"path": "/v1/events",
|
|
1425
1425
|
"auth": true,
|
|
1426
1426
|
"summary": "List events",
|
|
1427
1427
|
"credits": 1,
|
|
@@ -1638,7 +1638,7 @@
|
|
|
1638
1638
|
"group": "events",
|
|
1639
1639
|
"action": "live-audio",
|
|
1640
1640
|
"method": "get",
|
|
1641
|
-
"path": "/
|
|
1641
|
+
"path": "/v1/events/{event_id}/live-audio",
|
|
1642
1642
|
"auth": true,
|
|
1643
1643
|
"summary": "Get an event's live audio URL",
|
|
1644
1644
|
"credits": 5,
|
|
@@ -1675,7 +1675,7 @@
|
|
|
1675
1675
|
"group": "events",
|
|
1676
1676
|
"action": "press-release",
|
|
1677
1677
|
"method": "get",
|
|
1678
|
-
"path": "/
|
|
1678
|
+
"path": "/v1/events/{event_id}/press-release",
|
|
1679
1679
|
"auth": true,
|
|
1680
1680
|
"summary": "Get an event's press release",
|
|
1681
1681
|
"credits": 1,
|
|
@@ -1715,7 +1715,7 @@
|
|
|
1715
1715
|
"group": "events",
|
|
1716
1716
|
"action": "price-attribution",
|
|
1717
1717
|
"method": "get",
|
|
1718
|
-
"path": "/
|
|
1718
|
+
"path": "/v1/events/{event_id}/price-attribution",
|
|
1719
1719
|
"auth": true,
|
|
1720
1720
|
"summary": "Get an event's price attribution",
|
|
1721
1721
|
"credits": 1,
|
|
@@ -1757,7 +1757,7 @@
|
|
|
1757
1757
|
"group": "events",
|
|
1758
1758
|
"action": "prosody",
|
|
1759
1759
|
"method": "get",
|
|
1760
|
-
"path": "/
|
|
1760
|
+
"path": "/v1/events/{event_id}/prosody",
|
|
1761
1761
|
"auth": true,
|
|
1762
1762
|
"summary": "Get an event's speech prosody",
|
|
1763
1763
|
"credits": 1,
|
|
@@ -1806,7 +1806,7 @@
|
|
|
1806
1806
|
"group": "events",
|
|
1807
1807
|
"action": "qa",
|
|
1808
1808
|
"method": "get",
|
|
1809
|
-
"path": "/
|
|
1809
|
+
"path": "/v1/events/{event_id}/qa",
|
|
1810
1810
|
"auth": true,
|
|
1811
1811
|
"summary": "List an event's Q&A pairs",
|
|
1812
1812
|
"credits": 1,
|
|
@@ -1884,7 +1884,7 @@
|
|
|
1884
1884
|
"group": "events",
|
|
1885
1885
|
"action": "slides",
|
|
1886
1886
|
"method": "get",
|
|
1887
|
-
"path": "/
|
|
1887
|
+
"path": "/v1/events/{event_id}/slides",
|
|
1888
1888
|
"auth": true,
|
|
1889
1889
|
"summary": "Get an event's slides",
|
|
1890
1890
|
"credits": 5,
|
|
@@ -1938,7 +1938,7 @@
|
|
|
1938
1938
|
"group": "events",
|
|
1939
1939
|
"action": "stats",
|
|
1940
1940
|
"method": "get",
|
|
1941
|
-
"path": "/
|
|
1941
|
+
"path": "/v1/events/{event_id}/stats",
|
|
1942
1942
|
"auth": true,
|
|
1943
1943
|
"summary": "Get an event's call statistics",
|
|
1944
1944
|
"credits": 1,
|
|
@@ -1982,7 +1982,7 @@
|
|
|
1982
1982
|
"group": "events",
|
|
1983
1983
|
"action": "transcript",
|
|
1984
1984
|
"method": "get",
|
|
1985
|
-
"path": "/
|
|
1985
|
+
"path": "/v1/events/{event_id}/transcript",
|
|
1986
1986
|
"auth": true,
|
|
1987
1987
|
"summary": "Get an event's transcript",
|
|
1988
1988
|
"credits": 5,
|
|
@@ -2059,7 +2059,7 @@
|
|
|
2059
2059
|
"group": "events",
|
|
2060
2060
|
"action": "transcript-diff",
|
|
2061
2061
|
"method": "get",
|
|
2062
|
-
"path": "/
|
|
2062
|
+
"path": "/v1/events/{event_id}/transcript-diff",
|
|
2063
2063
|
"auth": true,
|
|
2064
2064
|
"summary": "Diff two transcript versions",
|
|
2065
2065
|
"credits": 5,
|
|
@@ -2115,7 +2115,7 @@
|
|
|
2115
2115
|
"group": "events",
|
|
2116
2116
|
"action": "transcript-text",
|
|
2117
2117
|
"method": "get",
|
|
2118
|
-
"path": "/
|
|
2118
|
+
"path": "/v1/events/{event_id}/transcript-text",
|
|
2119
2119
|
"auth": true,
|
|
2120
2120
|
"summary": "Get an event's transcript as text",
|
|
2121
2121
|
"credits": 5,
|
|
@@ -2173,7 +2173,7 @@
|
|
|
2173
2173
|
"group": "events",
|
|
2174
2174
|
"action": "transcript-versions",
|
|
2175
2175
|
"method": "get",
|
|
2176
|
-
"path": "/
|
|
2176
|
+
"path": "/v1/events/{event_id}/transcript-versions",
|
|
2177
2177
|
"auth": true,
|
|
2178
2178
|
"summary": "List an event's transcript versions",
|
|
2179
2179
|
"credits": 1,
|
|
@@ -2234,7 +2234,7 @@
|
|
|
2234
2234
|
"group": "filers",
|
|
2235
2235
|
"action": "get",
|
|
2236
2236
|
"method": "get",
|
|
2237
|
-
"path": "/
|
|
2237
|
+
"path": "/v1/filers/{cik}",
|
|
2238
2238
|
"auth": true,
|
|
2239
2239
|
"summary": "Get a filer",
|
|
2240
2240
|
"credits": 1,
|
|
@@ -2301,7 +2301,7 @@
|
|
|
2301
2301
|
"group": "filers",
|
|
2302
2302
|
"action": "list",
|
|
2303
2303
|
"method": "get",
|
|
2304
|
-
"path": "/
|
|
2304
|
+
"path": "/v1/filers",
|
|
2305
2305
|
"auth": true,
|
|
2306
2306
|
"summary": "List SEC filers",
|
|
2307
2307
|
"credits": 1,
|
|
@@ -2425,7 +2425,7 @@
|
|
|
2425
2425
|
"group": "filings",
|
|
2426
2426
|
"action": "datasets",
|
|
2427
2427
|
"method": "get",
|
|
2428
|
-
"path": "/
|
|
2428
|
+
"path": "/v1/datasets",
|
|
2429
2429
|
"auth": true,
|
|
2430
2430
|
"summary": "List SEC dataset releases",
|
|
2431
2431
|
"credits": 1,
|
|
@@ -2479,7 +2479,7 @@
|
|
|
2479
2479
|
"group": "filings",
|
|
2480
2480
|
"action": "facts",
|
|
2481
2481
|
"method": "get",
|
|
2482
|
-
"path": "/
|
|
2482
|
+
"path": "/v1/filings/{accession}/facts",
|
|
2483
2483
|
"auth": true,
|
|
2484
2484
|
"summary": "List a filing's numeric facts",
|
|
2485
2485
|
"credits": 1,
|
|
@@ -2562,7 +2562,7 @@
|
|
|
2562
2562
|
"group": "filings",
|
|
2563
2563
|
"action": "get",
|
|
2564
2564
|
"method": "get",
|
|
2565
|
-
"path": "/
|
|
2565
|
+
"path": "/v1/filings/{accession}",
|
|
2566
2566
|
"auth": true,
|
|
2567
2567
|
"summary": "Get a filing",
|
|
2568
2568
|
"credits": 1,
|
|
@@ -2627,7 +2627,7 @@
|
|
|
2627
2627
|
"group": "filings",
|
|
2628
2628
|
"action": "list",
|
|
2629
2629
|
"method": "get",
|
|
2630
|
-
"path": "/
|
|
2630
|
+
"path": "/v1/filings",
|
|
2631
2631
|
"auth": true,
|
|
2632
2632
|
"summary": "List filings",
|
|
2633
2633
|
"credits": 1,
|
|
@@ -2773,7 +2773,7 @@
|
|
|
2773
2773
|
"group": "filings",
|
|
2774
2774
|
"action": "notes",
|
|
2775
2775
|
"method": "get",
|
|
2776
|
-
"path": "/
|
|
2776
|
+
"path": "/v1/filings/{accession}/notes",
|
|
2777
2777
|
"auth": true,
|
|
2778
2778
|
"summary": "List a filing's text facts",
|
|
2779
2779
|
"credits": 1,
|
|
@@ -2850,7 +2850,7 @@
|
|
|
2850
2850
|
"group": "filings",
|
|
2851
2851
|
"action": "review-chain",
|
|
2852
2852
|
"method": "get",
|
|
2853
|
-
"path": "/
|
|
2853
|
+
"path": "/v1/filings/{accession}/review-chain",
|
|
2854
2854
|
"auth": true,
|
|
2855
2855
|
"summary": "Get a filing's review chain",
|
|
2856
2856
|
"credits": 1,
|
|
@@ -2930,7 +2930,7 @@
|
|
|
2930
2930
|
"group": "financials",
|
|
2931
2931
|
"action": "",
|
|
2932
2932
|
"method": "get",
|
|
2933
|
-
"path": "/
|
|
2933
|
+
"path": "/v1/financials/as-reported",
|
|
2934
2934
|
"auth": true,
|
|
2935
2935
|
"summary": "As-reported statements",
|
|
2936
2936
|
"credits": 1,
|
|
@@ -3153,7 +3153,7 @@
|
|
|
3153
3153
|
"group": "financials",
|
|
3154
3154
|
"action": "",
|
|
3155
3155
|
"method": "get",
|
|
3156
|
-
"path": "/
|
|
3156
|
+
"path": "/v1/financials/as-reported/detailed",
|
|
3157
3157
|
"auth": true,
|
|
3158
3158
|
"summary": "As-reported statements with labels",
|
|
3159
3159
|
"credits": 1,
|
|
@@ -3376,7 +3376,7 @@
|
|
|
3376
3376
|
"group": "financials",
|
|
3377
3377
|
"action": "",
|
|
3378
3378
|
"method": "get",
|
|
3379
|
-
"path": "/
|
|
3379
|
+
"path": "/v1/financials/as-reported/presentation",
|
|
3380
3380
|
"auth": true,
|
|
3381
3381
|
"summary": "As-reported statements as the filer's tree",
|
|
3382
3382
|
"credits": 1,
|
|
@@ -3599,7 +3599,7 @@
|
|
|
3599
3599
|
"group": "financials",
|
|
3600
3600
|
"action": "",
|
|
3601
3601
|
"method": "get",
|
|
3602
|
-
"path": "/
|
|
3602
|
+
"path": "/v1/financials/standardized",
|
|
3603
3603
|
"auth": true,
|
|
3604
3604
|
"summary": "Standardized statements",
|
|
3605
3605
|
"credits": 1,
|
|
@@ -3798,7 +3798,7 @@
|
|
|
3798
3798
|
"group": "financials",
|
|
3799
3799
|
"action": "",
|
|
3800
3800
|
"method": "get",
|
|
3801
|
-
"path": "/
|
|
3801
|
+
"path": "/v1/financials/standardized/detailed",
|
|
3802
3802
|
"auth": true,
|
|
3803
3803
|
"summary": "Standardized statements with lineage",
|
|
3804
3804
|
"credits": 1,
|
|
@@ -3997,7 +3997,7 @@
|
|
|
3997
3997
|
"group": "financials",
|
|
3998
3998
|
"action": "",
|
|
3999
3999
|
"method": "get",
|
|
4000
|
-
"path": "/
|
|
4000
|
+
"path": "/v1/financials/standardized/presentation",
|
|
4001
4001
|
"auth": true,
|
|
4002
4002
|
"summary": "Standardized statements as a tree",
|
|
4003
4003
|
"credits": 1,
|
|
@@ -4196,7 +4196,7 @@
|
|
|
4196
4196
|
"group": "guidance",
|
|
4197
4197
|
"action": "kpis",
|
|
4198
4198
|
"method": "get",
|
|
4199
|
-
"path": "/
|
|
4199
|
+
"path": "/v1/kpis",
|
|
4200
4200
|
"auth": true,
|
|
4201
4201
|
"summary": "List KPI mentions",
|
|
4202
4202
|
"credits": 1,
|
|
@@ -4314,7 +4314,7 @@
|
|
|
4314
4314
|
"group": "guidance",
|
|
4315
4315
|
"action": "list",
|
|
4316
4316
|
"method": "get",
|
|
4317
|
-
"path": "/
|
|
4317
|
+
"path": "/v1/guidance",
|
|
4318
4318
|
"auth": true,
|
|
4319
4319
|
"summary": "List guidance items",
|
|
4320
4320
|
"credits": 1,
|
|
@@ -4473,7 +4473,7 @@
|
|
|
4473
4473
|
"group": "holdings",
|
|
4474
4474
|
"action": "changes",
|
|
4475
4475
|
"method": "get",
|
|
4476
|
-
"path": "/
|
|
4476
|
+
"path": "/v1/holding-changes",
|
|
4477
4477
|
"auth": true,
|
|
4478
4478
|
"summary": "List 13F position changes",
|
|
4479
4479
|
"credits": 1,
|
|
@@ -4606,7 +4606,7 @@
|
|
|
4606
4606
|
"group": "holdings",
|
|
4607
4607
|
"action": "list",
|
|
4608
4608
|
"method": "get",
|
|
4609
|
-
"path": "/
|
|
4609
|
+
"path": "/v1/holdings",
|
|
4610
4610
|
"auth": true,
|
|
4611
4611
|
"summary": "List 13F holdings",
|
|
4612
4612
|
"credits": 1,
|
|
@@ -4752,7 +4752,7 @@
|
|
|
4752
4752
|
"group": "insider-trades",
|
|
4753
4753
|
"action": "get",
|
|
4754
4754
|
"method": "get",
|
|
4755
|
-
"path": "/
|
|
4755
|
+
"path": "/v1/insider-trades/{id}",
|
|
4756
4756
|
"auth": true,
|
|
4757
4757
|
"summary": "Get an insider trade",
|
|
4758
4758
|
"credits": 1,
|
|
@@ -4818,7 +4818,7 @@
|
|
|
4818
4818
|
"group": "insider-trades",
|
|
4819
4819
|
"action": "list",
|
|
4820
4820
|
"method": "get",
|
|
4821
|
-
"path": "/
|
|
4821
|
+
"path": "/v1/insider-trades",
|
|
4822
4822
|
"auth": true,
|
|
4823
4823
|
"summary": "List insider trades",
|
|
4824
4824
|
"credits": 1,
|
|
@@ -4970,7 +4970,7 @@
|
|
|
4970
4970
|
"group": "investor-documents",
|
|
4971
4971
|
"action": "get",
|
|
4972
4972
|
"method": "get",
|
|
4973
|
-
"path": "/
|
|
4973
|
+
"path": "/v1/investor-documents/{document_id}",
|
|
4974
4974
|
"auth": true,
|
|
4975
4975
|
"summary": "Get an investor document",
|
|
4976
4976
|
"credits": 1,
|
|
@@ -5047,7 +5047,7 @@
|
|
|
5047
5047
|
"group": "investor-documents",
|
|
5048
5048
|
"action": "list",
|
|
5049
5049
|
"method": "get",
|
|
5050
|
-
"path": "/
|
|
5050
|
+
"path": "/v1/investor-documents",
|
|
5051
5051
|
"auth": true,
|
|
5052
5052
|
"summary": "List investor documents",
|
|
5053
5053
|
"credits": 1,
|
|
@@ -5201,7 +5201,7 @@
|
|
|
5201
5201
|
"group": "ipos",
|
|
5202
5202
|
"action": "get",
|
|
5203
5203
|
"method": "get",
|
|
5204
|
-
"path": "/
|
|
5204
|
+
"path": "/v1/ipos/{ipo_id}",
|
|
5205
5205
|
"auth": true,
|
|
5206
5206
|
"summary": "Get an offering",
|
|
5207
5207
|
"credits": 1,
|
|
@@ -5260,7 +5260,7 @@
|
|
|
5260
5260
|
"group": "ipos",
|
|
5261
5261
|
"action": "list",
|
|
5262
5262
|
"method": "get",
|
|
5263
|
-
"path": "/
|
|
5263
|
+
"path": "/v1/ipos",
|
|
5264
5264
|
"auth": true,
|
|
5265
5265
|
"summary": "List offerings",
|
|
5266
5266
|
"credits": 1,
|
|
@@ -5408,7 +5408,7 @@
|
|
|
5408
5408
|
"group": "market",
|
|
5409
5409
|
"action": "holidays",
|
|
5410
5410
|
"method": "get",
|
|
5411
|
-
"path": "/
|
|
5411
|
+
"path": "/v1/market-holidays",
|
|
5412
5412
|
"auth": true,
|
|
5413
5413
|
"summary": "List market holidays",
|
|
5414
5414
|
"credits": 1,
|
|
@@ -5512,7 +5512,7 @@
|
|
|
5512
5512
|
"group": "me",
|
|
5513
5513
|
"action": "show",
|
|
5514
5514
|
"method": "get",
|
|
5515
|
-
"path": "/
|
|
5515
|
+
"path": "/v1/me",
|
|
5516
5516
|
"auth": true,
|
|
5517
5517
|
"summary": "Who am I",
|
|
5518
5518
|
"credits": 0,
|
|
@@ -5536,7 +5536,7 @@
|
|
|
5536
5536
|
"group": "me",
|
|
5537
5537
|
"action": "usage",
|
|
5538
5538
|
"method": "get",
|
|
5539
|
-
"path": "/
|
|
5539
|
+
"path": "/v1/me/usage",
|
|
5540
5540
|
"auth": true,
|
|
5541
5541
|
"summary": "Get my usage",
|
|
5542
5542
|
"credits": 0,
|
|
@@ -5575,7 +5575,7 @@
|
|
|
5575
5575
|
"group": "metrics",
|
|
5576
5576
|
"action": "cagr",
|
|
5577
5577
|
"method": "get",
|
|
5578
|
-
"path": "/
|
|
5578
|
+
"path": "/v1/metrics/cagr",
|
|
5579
5579
|
"auth": true,
|
|
5580
5580
|
"summary": "List CAGRs",
|
|
5581
5581
|
"credits": 1,
|
|
@@ -5731,7 +5731,7 @@
|
|
|
5731
5731
|
"group": "metrics",
|
|
5732
5732
|
"action": "explain",
|
|
5733
5733
|
"method": "get",
|
|
5734
|
-
"path": "/
|
|
5734
|
+
"path": "/v1/facts/{fact_id}",
|
|
5735
5735
|
"auth": true,
|
|
5736
5736
|
"summary": "Explain a standardized fact",
|
|
5737
5737
|
"credits": 1,
|
|
@@ -5794,7 +5794,7 @@
|
|
|
5794
5794
|
"group": "metrics",
|
|
5795
5795
|
"action": "growth",
|
|
5796
5796
|
"method": "get",
|
|
5797
|
-
"path": "/
|
|
5797
|
+
"path": "/v1/metrics/growth",
|
|
5798
5798
|
"auth": true,
|
|
5799
5799
|
"summary": "List growth rates",
|
|
5800
5800
|
"credits": 1,
|
|
@@ -5951,7 +5951,7 @@
|
|
|
5951
5951
|
"group": "metrics",
|
|
5952
5952
|
"action": "ratios",
|
|
5953
5953
|
"method": "get",
|
|
5954
|
-
"path": "/
|
|
5954
|
+
"path": "/v1/metrics/ratios",
|
|
5955
5955
|
"auth": true,
|
|
5956
5956
|
"summary": "List ratios",
|
|
5957
5957
|
"credits": 1,
|
|
@@ -6102,7 +6102,7 @@
|
|
|
6102
6102
|
"group": "news",
|
|
6103
6103
|
"action": "announcements",
|
|
6104
6104
|
"method": "get",
|
|
6105
|
-
"path": "/
|
|
6105
|
+
"path": "/v1/announcements",
|
|
6106
6106
|
"auth": true,
|
|
6107
6107
|
"summary": "List announcements",
|
|
6108
6108
|
"credits": 2,
|
|
@@ -6275,7 +6275,7 @@
|
|
|
6275
6275
|
"group": "news",
|
|
6276
6276
|
"action": "get",
|
|
6277
6277
|
"method": "get",
|
|
6278
|
-
"path": "/
|
|
6278
|
+
"path": "/v1/news/{id}",
|
|
6279
6279
|
"auth": true,
|
|
6280
6280
|
"summary": "Get a news item",
|
|
6281
6281
|
"credits": 2,
|
|
@@ -6341,7 +6341,7 @@
|
|
|
6341
6341
|
"group": "news",
|
|
6342
6342
|
"action": "list",
|
|
6343
6343
|
"method": "get",
|
|
6344
|
-
"path": "/
|
|
6344
|
+
"path": "/v1/news",
|
|
6345
6345
|
"auth": true,
|
|
6346
6346
|
"summary": "List news items",
|
|
6347
6347
|
"credits": 1,
|
|
@@ -6511,7 +6511,7 @@
|
|
|
6511
6511
|
"group": "news",
|
|
6512
6512
|
"action": "text",
|
|
6513
6513
|
"method": "get",
|
|
6514
|
-
"path": "/
|
|
6514
|
+
"path": "/v1/news/{id}/text",
|
|
6515
6515
|
"auth": true,
|
|
6516
6516
|
"summary": "Get a news item's text",
|
|
6517
6517
|
"credits": 2,
|
|
@@ -6571,7 +6571,7 @@
|
|
|
6571
6571
|
"group": "people",
|
|
6572
6572
|
"action": "get",
|
|
6573
6573
|
"method": "get",
|
|
6574
|
-
"path": "/
|
|
6574
|
+
"path": "/v1/people/{person_id}",
|
|
6575
6575
|
"auth": true,
|
|
6576
6576
|
"summary": "Get a person",
|
|
6577
6577
|
"credits": 1,
|
|
@@ -6631,7 +6631,7 @@
|
|
|
6631
6631
|
"group": "people",
|
|
6632
6632
|
"action": "list",
|
|
6633
6633
|
"method": "get",
|
|
6634
|
-
"path": "/
|
|
6634
|
+
"path": "/v1/people",
|
|
6635
6635
|
"auth": true,
|
|
6636
6636
|
"summary": "List people",
|
|
6637
6637
|
"credits": 1,
|
|
@@ -6768,7 +6768,7 @@
|
|
|
6768
6768
|
"group": "people",
|
|
6769
6769
|
"action": "participants",
|
|
6770
6770
|
"method": "get",
|
|
6771
|
-
"path": "/
|
|
6771
|
+
"path": "/v1/participants",
|
|
6772
6772
|
"auth": true,
|
|
6773
6773
|
"summary": "List event participations",
|
|
6774
6774
|
"credits": 1,
|
|
@@ -6869,7 +6869,7 @@
|
|
|
6869
6869
|
"group": "search",
|
|
6870
6870
|
"action": "filings",
|
|
6871
6871
|
"method": "get",
|
|
6872
|
-
"path": "/
|
|
6872
|
+
"path": "/v1/search/filings",
|
|
6873
6873
|
"auth": true,
|
|
6874
6874
|
"summary": "Search filings",
|
|
6875
6875
|
"credits": 100,
|
|
@@ -7028,7 +7028,7 @@
|
|
|
7028
7028
|
"group": "search",
|
|
7029
7029
|
"action": "investor-documents",
|
|
7030
7030
|
"method": "get",
|
|
7031
|
-
"path": "/
|
|
7031
|
+
"path": "/v1/search/investor-documents",
|
|
7032
7032
|
"auth": true,
|
|
7033
7033
|
"summary": "Search investor documents",
|
|
7034
7034
|
"credits": 10,
|
|
@@ -7141,7 +7141,7 @@
|
|
|
7141
7141
|
"group": "search",
|
|
7142
7142
|
"action": "news",
|
|
7143
7143
|
"method": "get",
|
|
7144
|
-
"path": "/
|
|
7144
|
+
"path": "/v1/search/news",
|
|
7145
7145
|
"auth": true,
|
|
7146
7146
|
"summary": "Search news",
|
|
7147
7147
|
"credits": 10,
|
|
@@ -7284,7 +7284,7 @@
|
|
|
7284
7284
|
"group": "search",
|
|
7285
7285
|
"action": "transcripts",
|
|
7286
7286
|
"method": "get",
|
|
7287
|
-
"path": "/
|
|
7287
|
+
"path": "/v1/search/transcripts",
|
|
7288
7288
|
"auth": true,
|
|
7289
7289
|
"summary": "Search transcripts",
|
|
7290
7290
|
"credits": 10,
|
|
@@ -7439,7 +7439,7 @@
|
|
|
7439
7439
|
"group": "segments",
|
|
7440
7440
|
"action": "list",
|
|
7441
7441
|
"method": "get",
|
|
7442
|
-
"path": "/
|
|
7442
|
+
"path": "/v1/segments",
|
|
7443
7443
|
"auth": true,
|
|
7444
7444
|
"summary": "List segment values",
|
|
7445
7445
|
"credits": 1,
|
|
@@ -7604,7 +7604,7 @@
|
|
|
7604
7604
|
"group": "segments",
|
|
7605
7605
|
"action": "list-detailed",
|
|
7606
7606
|
"method": "get",
|
|
7607
|
-
"path": "/
|
|
7607
|
+
"path": "/v1/segments/detailed",
|
|
7608
7608
|
"auth": true,
|
|
7609
7609
|
"summary": "List segment values with lineage",
|
|
7610
7610
|
"credits": 1,
|
|
@@ -7775,7 +7775,7 @@
|
|
|
7775
7775
|
"group": "webhooks",
|
|
7776
7776
|
"action": "create",
|
|
7777
7777
|
"method": "post",
|
|
7778
|
-
"path": "/
|
|
7778
|
+
"path": "/v1/webhooks",
|
|
7779
7779
|
"auth": true,
|
|
7780
7780
|
"summary": "Create a webhook",
|
|
7781
7781
|
"credits": 1,
|
|
@@ -7878,7 +7878,7 @@
|
|
|
7878
7878
|
"group": "webhooks",
|
|
7879
7879
|
"action": "delete",
|
|
7880
7880
|
"method": "delete",
|
|
7881
|
-
"path": "/
|
|
7881
|
+
"path": "/v1/webhooks/{id}",
|
|
7882
7882
|
"auth": true,
|
|
7883
7883
|
"summary": "Delete a webhook",
|
|
7884
7884
|
"credits": 1,
|
|
@@ -7907,7 +7907,7 @@
|
|
|
7907
7907
|
"group": "webhooks",
|
|
7908
7908
|
"action": "deliveries",
|
|
7909
7909
|
"method": "get",
|
|
7910
|
-
"path": "/
|
|
7910
|
+
"path": "/v1/webhooks/{id}/deliveries",
|
|
7911
7911
|
"auth": true,
|
|
7912
7912
|
"summary": "List a webhook's deliveries",
|
|
7913
7913
|
"credits": 1,
|
|
@@ -7971,7 +7971,7 @@
|
|
|
7971
7971
|
"group": "webhooks",
|
|
7972
7972
|
"action": "get",
|
|
7973
7973
|
"method": "get",
|
|
7974
|
-
"path": "/
|
|
7974
|
+
"path": "/v1/webhooks/{id}",
|
|
7975
7975
|
"auth": true,
|
|
7976
7976
|
"summary": "Get a webhook",
|
|
7977
7977
|
"credits": 1,
|
|
@@ -8017,7 +8017,7 @@
|
|
|
8017
8017
|
"group": "webhooks",
|
|
8018
8018
|
"action": "list",
|
|
8019
8019
|
"method": "get",
|
|
8020
|
-
"path": "/
|
|
8020
|
+
"path": "/v1/webhooks",
|
|
8021
8021
|
"auth": true,
|
|
8022
8022
|
"summary": "List webhooks",
|
|
8023
8023
|
"credits": 1,
|
|
@@ -8069,7 +8069,7 @@
|
|
|
8069
8069
|
"group": "webhooks",
|
|
8070
8070
|
"action": "rotate-secret",
|
|
8071
8071
|
"method": "post",
|
|
8072
|
-
"path": "/
|
|
8072
|
+
"path": "/v1/webhooks/{id}:rotate-secret",
|
|
8073
8073
|
"auth": true,
|
|
8074
8074
|
"summary": "Rotate a webhook's secret",
|
|
8075
8075
|
"credits": 1,
|
|
@@ -8105,7 +8105,7 @@
|
|
|
8105
8105
|
"group": "webhooks",
|
|
8106
8106
|
"action": "test",
|
|
8107
8107
|
"method": "post",
|
|
8108
|
-
"path": "/
|
|
8108
|
+
"path": "/v1/webhooks/{id}:test",
|
|
8109
8109
|
"auth": true,
|
|
8110
8110
|
"summary": "Send a test delivery",
|
|
8111
8111
|
"credits": 1,
|
|
@@ -8134,7 +8134,7 @@
|
|
|
8134
8134
|
"group": "webhooks",
|
|
8135
8135
|
"action": "update",
|
|
8136
8136
|
"method": "patch",
|
|
8137
|
-
"path": "/
|
|
8137
|
+
"path": "/v1/webhooks/{id}",
|
|
8138
8138
|
"auth": true,
|
|
8139
8139
|
"summary": "Update a webhook",
|
|
8140
8140
|
"credits": 1,
|
|
@@ -149,7 +149,7 @@ function addPositionals(command, operation) {
|
|
|
149
149
|
const description = param?.description ?? positional.name;
|
|
150
150
|
if (positional.name === 'event_id') {
|
|
151
151
|
command.argument('<event_id>', `${description}; or a company followed by a fiscal period (NVDA 2026Q3)`);
|
|
152
|
-
command.argument('[fiscal_period]', 'With a company in place of the event id: the fiscal period (2026Q3), resolved through GET /
|
|
152
|
+
command.argument('[fiscal_period]', 'With a company in place of the event id: the fiscal period (2026Q3), resolved through GET /v1/events');
|
|
153
153
|
return;
|
|
154
154
|
}
|
|
155
155
|
const name = positional.variadic ? `${positional.name}...` : positional.name;
|
|
@@ -248,7 +248,7 @@ async function planRequest(operation, positionals, opts, context) {
|
|
|
248
248
|
throw new UsageError(`${second} is not a fiscal period (expected e.g. 2026Q3)`);
|
|
249
249
|
lookup = {
|
|
250
250
|
request: {
|
|
251
|
-
path: '/
|
|
251
|
+
path: '/v1/events',
|
|
252
252
|
query: { company: String(first), fiscal_year: period.fiscalYear, fiscal_quarter: period.fiscalQuarter, limit: '1' },
|
|
253
253
|
},
|
|
254
254
|
company: String(first),
|
|
@@ -402,8 +402,8 @@ async function resolveLookup(plan) {
|
|
|
402
402
|
const row = isRecord(body) && Array.isArray(body.data) ? body.data[0] : undefined;
|
|
403
403
|
const eventId = isRecord(row) && typeof row.event_id === 'string' ? row.event_id : undefined;
|
|
404
404
|
if (!eventId)
|
|
405
|
-
throw new Error(`No event for ${plan.lookup.company} ${plan.lookup.period} (GET /
|
|
406
|
-
console.error(chalk.dim(`resolved ${plan.lookup.company} ${plan.lookup.period} → event ${eventId} (GET /
|
|
405
|
+
throw new Error(`No event for ${plan.lookup.company} ${plan.lookup.period} (GET /v1/events)`);
|
|
406
|
+
console.error(chalk.dim(`resolved ${plan.lookup.company} ${plan.lookup.period} → event ${eventId} (GET /v1/events, ${plan.lookup.credits} credit)`));
|
|
407
407
|
return { request: { ...plan.request, path: plan.request.path.replace('{event_id}', encodeURIComponent(eventId)) } };
|
|
408
408
|
}
|
|
409
409
|
async function saveDownload(operation, body, file, force) {
|