Skip to main content
POST
/
api
/
federalregister
/
documents
/
facets
/federalregister/documents/facets
curl --request POST \
  --url https://api.anysite.io/api/federalregister/documents/facets \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "timeout": 300,
  "term": "<string>",
  "type": [],
  "agencies": [
    "<string>"
  ],
  "agency_ids": [
    123
  ],
  "topics": [
    "<string>"
  ],
  "sections": [],
  "publication_date_gte": "<string>",
  "publication_date_lte": "<string>",
  "publication_date_year": 123,
  "significant": true
}
'
[
  {
    "value": "<string>",
    "@type": "@federalregister_facet_bucket",
    "name": "<string>",
    "count": 123
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
facet
enum<string>
required

Facet to aggregate document counts by

Available options:
daily,
weekly,
monthly,
quarterly,
yearly,
agency,
topic,
type,
subtype,
section
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
term
string | null

Full-text search keyword to narrow the aggregation

​
type
enum<string>[] | null

Filter by document type

Available options:
RULE,
PRORULE,
NOTICE,
PRESDOCU
​
agencies
string[] | null

Filter by agency slug(s)

​
agency_ids
integer[] | null

Filter by numeric agency id(s)

​
topics
string[] | null

Filter by topic / CFR indexing term(s)

​
sections
enum<string>[] | null

Filter by Federal Register section

Available options:
money,
environment,
world,
science-and-technology,
business-and-industry,
health-and-public-welfare
​
publication_date_gte
string | null

Earliest publication date, inclusive (MM/DD/YYYY)

​
publication_date_lte
string | null

Latest publication date, inclusive (MM/DD/YYYY)

​
publication_date_year
integer | null

Publication year

​
significant
boolean | null

Only documents deemed significant

Response

Successful Response

​
value
string
required
​
@type
string
default:@federalregister_facet_bucket
​
name
string | null
​
count
integer | null