Skip to content

OpenAPI spec and docs for the Edgar Lens REST API (auth, diffs, red flags, search, citations). Source of truth for the Edgar Lens API. Includes the OpenAPI spec, example requests (curl/JS/Python), error codes, rate limits, and changelog. CI auto-generates SDKs and publishes docs.

License

Notifications You must be signed in to change notification settings

edgarlens/openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

Edgar Lens OpenAPI Specification

Overview

This repository contains the OpenAPI specification for the Edgar Lens API, plus example requests, error codes, and changelog.

The API exposes:

  • AI-powered semantic diffs of SEC filings
  • Red-flag detection (risk factor changes, restatements, auditor changes)
  • Sourced Q&A over filings
  • Watchlists & alerts

View the Spec

The latest spec is in openapi.yaml.

Quick Start

curl -X POST "https://api.edgarlens.com/v1/diff" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticker":"AAPL"}'

SDKs

Docs

Once live: https://docs.edgarlens.com

Contributing

Open an issue for questions or proposed changes to the spec. See CONTRIBUTING.md.

License

Apache License 2.0 — see LICENSE.

About

OpenAPI spec and docs for the Edgar Lens REST API (auth, diffs, red flags, search, citations). Source of truth for the Edgar Lens API. Includes the OpenAPI spec, example requests (curl/JS/Python), error codes, rate limits, and changelog. CI auto-generates SDKs and publishes docs.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published