Skip to content

docs: clarify JavaScript SDK quickstart#17

Draft
daniel-scrivner wants to merge 1 commit into
mainfrom
codex/editorial-js-20260716
Draft

docs: clarify JavaScript SDK quickstart#17
daniel-scrivner wants to merge 1 commit into
mainfrom
codex/editorial-js-20260716

Conversation

@daniel-scrivner

Copy link
Copy Markdown
Contributor

Scope

  • Make the README start with installation, a contract-valid filing request, expected result, docs, compatibility, and support.
  • State the SDK's REST wrapper posture, hosted MCP boundary, and x-api-key authentication.

Factual self-audit

  • SecApiClient, agentLatestFiling(), SECAPI_API_KEY, and x-api-key were verified against this branch and current canonical docs.
  • The example records accession number, filing date, filing URL, and request ID; it does not promise a stable live filing.
  • No API behavior, package version, or package manifest changed.

GitHub metadata

  • Applied description: JavaScript and TypeScript SDK for source-backed SEC filings and financial data.
  • Homepage remains https://docs.secapi.ai; added sec-filings topic.

Registry delta

  • No npm publish attempted. Observed npm @secapi/sdk-js@1.3.0 description: JavaScript and TypeScript SDK for SEC filings, filing sections, financial statements, and ownership data.
  • Repository package.json still says client and points its homepage to https://secapi.ai/developers; the published metadata is unchanged and needs the normal release owner/mechanism for reconciliation.

Validation

  • bun test (117 pass)
  • bun run typecheck
  • git diff --check
  • Documentation-link HTTP checks

Tracks OMNI-5503 under OMNI-5326.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant