Changelog

1.0.0-beta.2

The OpenAPI document now matches what the API sends. No request changed, and no documented field of a response.

• Every figure is a Decimal or NullableDecimal: a string of digits with a sign and a fraction when there is one, never a number, so a client can parse it without losing digits. Prices, holders, segments and the filings of a day now say so as the metrics did.
• A value that can be null says so the OpenAPI 3.1 way, with null in its type. The 3.0 keyword the document used before is ignored by tools that read 3.1.
• keys, forms, items and tickers are arrays sent comma-separated (style: form, explode: false), as they always were on the wire.
• value_kind on a metric value is reported or derived, as it is in the catalog.
• A filing’s details and documents, a day’s counts by form and by day, and IEX’s attribution have named schemas.
• Endpoints are tagged by resource: securities, metrics, filings, insiders, holders, segments, prices, screen, releases.
• Filings no longer include a reading object, and lineage rows no longer include two review fields. Neither was in the document, so a client generated from it never read them.

A client generated from the previous document keeps working; generate it again to pick up the types.

1.0.0-beta.1

The first beta.

• Nineteen read-only endpoints: companies, metrics with point-in-time reads, lineage, revisions, raw concepts, filings, insider trades, institutional holders, segments, prices, the Screener and the current release.
• API keys, up to ten per account, with optional expiry.
• Limits of 60 requests a minute, 20,000 a month and 4 at a time per account, reported in the IETF RateLimit headers.
• Errors as RFC 9457 problem details.