Skip to main content
GET
One source we read, with a sample item

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer pd_live_…. Someone on your team makes one in the workspace, Settings › API keys; it's shown once. Staging's keys start with pd_test_.

Path Parameters

id
string
required
Maximum string length: 64
Example:

"edgar"

Response

The source, with a sample item

id
string
required
Example:

"edgar"

name
string
required
Example:

"SEC EDGAR filings (submissions and XBRL APIs)"

family
object
required
reads
string
required

What we read from it, one line

shapes
enum<string>[]
required
Available options:
document,
record,
signal
route
object
required
cadence
object
required
state
enum<string>
required

live: ran here within twice its cadence. late: ran here before, not since. by_request: a team asks for it

Available options:
live,
late,
by_request
last_ran
string<date-time> | null
required

When its reader last ran in this environment; null for a source by request that has not

held
object | null
required

How much we hold from it and since when, as of as_of; null where nothing counts it

terms
object
required
sample
object | null
required

One recent item with its link; null while it holds none

as_of
string<date-time>
required