Skip to main content
GET
Supply chain

Authorizations

X-API-KEY
string
header
default:pk_live_YOUR_KEY
required

Astreus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as Authorization: Bearer pk_live_....

Path Parameters

id
string
required

Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the cik field of the company payload). A bare ticker always resolves to the SEC registrant.

Query Parameters

role
enum<string>
default:all

customers, suppliers, competitors, partners or all (default).

Available options:
customers,
suppliers,
competitors,
partners,
all
quantified_only
enum<string>
default:false

true = only relationships with at least one eligible metric.

Available options:
true,
false
as_of
string

YYYY-MM-DD: public information through the end of that UTC date.

sort
enum<string>
default:company_exposure

company_exposure (default; the company's own metric), relationship_exposure (the other party's metric) or name. Metrics missing sort last, ties by edge key.

Available options:
company_exposure,
relationship_exposure,
name
limit
integer

1–100, default 50.

cursor
string

Opaque cursor bound to all filters and the data revision; restart on 409.

name
string

Counterparty name or ticker contains.

named_only
enum<string>

Exclude anonymous and grouped counterparties.

Available options:
true,
false
country
string

Two-letter country code.

sector
string

Exact sector name.

display_currency
string

Three-letter display currency; original amounts retained; historical FX unavailable.

include_historical
enum<string>
default:false

true = also return filing-scoped anonymous labels that a later report superseded.

Available options:
true,
false
include_estimates
enum<string>
default:false

true = include estimate-tier metrics (state=estimate), attributed by rule, never disclosed figures.

Available options:
true,
false

Response

OK

The response is of type object.