Skip to content

Official JavaScript/TypeScript SDK for the Edgar Lens API. Typed JS/TS client generated from the OpenAPI spec with ergonomic helpers (pagination, retries, typed models). Works in Node and modern browsers.

License

Notifications You must be signed in to change notification settings

edgarlens/sdk-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

Edgar Lens JavaScript SDK

Official JavaScript/TypeScript SDK for the Edgar Lens API.

Features

  • Strongly typed models (TypeScript)
  • Pagination & retries
  • Works in Node.js and modern browsers

Installation

npm install @edgarlens/sdk
# or
yarn add @edgarlens/sdk
# or
pnpm add @edgarlens/sdk

Quick Start

import { EdgarLens } from '@edgarlens/sdk';

const client = new EdgarLens({ apiKey: process.env.EDGARLENS_API_KEY! });

const diffs = await client.diffs.get({ ticker: 'AAPL' });
console.log(diffs);

Examples

See /examples for usage patterns (Node, browser, Next.js).

Versioning

Follows the API's semantic versioning. Breaking API changes bump the major version.

License

MIT — see LICENSE.

About

Official JavaScript/TypeScript SDK for the Edgar Lens API. Typed JS/TS client generated from the OpenAPI spec with ergonomic helpers (pagination, retries, typed models). Works in Node and modern browsers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published