Noozra Federal Register API

openapi: 3.2.0
info:
  title: Noozra Federal Register API
  version: 1.4.0
  contact:
    name: Noozra
    url: https://noozra.com
  termsOfService: https://noozra.com/terms
  description: 'Operations tagged Federal Register across 2 of this provider''s published API definitions: noozra-openapi.json, noozra-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://noozra.com
security:
- bearerAuth: []
tags:
- description: Rules, proposed rules, notices and presidential documents from the Federal Register.
  name: Federal Register
paths:
  /api/regulations:
    get:
      description: Rules, proposed rules, notices and presidential documents published in the Federal Register, from federalregister.gov. Each item's `date` is the day the document was published in the Federal Register. Sort with `sort`; page by passing `next_cursor` back as `cursor`. `as_of` is when the data was last known current. Records dated in the last 14 days for every key; API Pro reaches every record.
      operationId: listRegulations
      parameters:
      - description: Words in the title, action or abstract.
        in: query
        name: q
        required: false
        schema:
          maxLength: 200
          type: string
      - description: 'Document type: a final `rule`, a `proposed_rule`, a `notice`, or a `presidential` document.'
        in: query
        name: type
        required: false
        schema:
          enum:
          - rule
          - proposed_rule
          - notice
          - presidential
          type: string
      - description: Text found in the name of any agency the document is from, any case.
        in: query
        name: agency
        required: false
        schema:
          maxLength: 200
          type: string
      - description: '`true`: only documents still taking public comments (the comment deadline is today or later). `false`: only those that are not.'
        in: query
        name: comments_open
        required: false
        schema:
          type: boolean
      - description: Only records dated on or after this day (YYYY-MM-DD). Within the last 14 days for every key; earlier needs API Pro (403 otherwise).
        in: query
        name: after
        required: false
        schema:
          format: date
          type: string
      - description: '`newest`: by `date`, newest first; `deadline`: documents still taking comments, by comment deadline, soonest first.'
        in: query
        name: sort
        required: false
        schema:
          default: newest
          enum:
          - newest
          - deadline
          type: string
      - description: '`next_cursor` from the previous page, unchanged, with the same `sort`.'
        in: query
        name: cursor
        required: false
        schema:
          type: string
      - description: Items to return; clamped to 1–100.
        in: query
        name: limit
        required: false
        schema:
          default: 20
          maximum: 100
          minimum: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegulationsResponse'
          description: OK
          headers:
            X-Noozra-Plan:
              $ref: '#/components/headers/X-Noozra-Plan'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
        '400':
          description: A parameter out of shape (the `error` says which), a sort this dataset does not take, a cursor not given out for this sort, or a date outside 1970–9999
        '401':
          description: No API key, or an invalid or revoked one
        '403':
          description: '`after` reaches past the last 14 days: that needs API Pro'
        '429':
          description: Daily rate limit exceeded (honor the Retry-After header)
      security:
      - bearerAuth: []
      summary: List Federal Register documents
      tags:
      - Federal Register
    servers:
    - url: https://noozra.com
  /api/regulations/{id}:
    get:
      description: One record, in the shape `/api/regulations` lists it. Without API Pro, one dated in the last 14 days; with it, any record.
      operationId: getRegulation
      parameters:
      - description: An item's `id`.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Regulation'
          description: OK
          headers:
            X-Noozra-Plan:
              $ref: '#/components/headers/X-Noozra-Plan'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
        '400':
          description: Not a UUID
        '401':
          description: No API key, or an invalid or revoked one
        '404':
          description: Unknown id (or, without API Pro, a record outside the free reach)
        '429':
          description: Daily rate limit exceeded (honor the Retry-After header)
      security:
      - bearerAuth: []
      summary: One Federal Register document
      tags:
      - Federal Register
    servers:
    - url: https://noozra.com
components:
  schemas:
    Place:
      properties:
        address:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
        country:
          description: ISO 3166-1 alpha-3, such as USA.
          type:
          - string
          - 'null'
        latitude:
          type:
          - number
          - 'null'
        longitude:
          type:
          - number
          - 'null'
        state:
          description: Two-letter state.
          type:
          - string
          - 'null'
        zip:
          type:
          - string
          - 'null'
      required:
      - address
      - city
      - state
      - zip
      - country
      - latitude
      - longitude
      type: object
    RegulationsResponse:
      properties:
        as_of:
          description: 'When this dataset was last known current: the oldest last successful read among its sources (the city''s own, with `city`).'
          format: date-time
          type:
          - string
          - 'null'
        count:
          type: integer
        next_cursor:
          description: Pass as `cursor` for the next page; null at the end.
          type:
          - string
          - 'null'
        regulations:
          items:
            $ref: '#/components/schemas/Regulation'
          type: array
      required:
      - regulations
      - count
      - next_cursor
      - as_of
      type: object
    Regulation:
      properties:
        action:
          description: What the document does, in the agency's words, such as "Final rule."
          type:
          - string
          - 'null'
        agencies:
          description: The agencies the document is from.
          items:
            type: string
          type: array
        comments_close_date:
          format: date
          type:
          - string
          - 'null'
        comments_open:
          description: The comment deadline is today or later.
          type: boolean
        date:
          description: 'YYYY-MM-DD: the day the document was published in the Federal Register.'
          format: date
          type: string
        description:
          description: The source's own text, at most 1000 characters.
          type:
          - string
          - 'null'
        docket_ids:
          items:
            type: string
          type: array
        effective_date:
          format: date
          type:
          - string
          - 'null'
        id:
          format: uuid
          type: string
        place:
          $ref: '#/components/schemas/Place'
        reference:
          description: The record's own number at its source.
          type: string
        rins:
          description: Regulation Identifier Numbers.
          items:
            type: string
          type: array
        significant:
          description: Significant under Executive Order 12866, where the document says.
          type:
          - boolean
          - 'null'
        source:
          description: Who published the record. Name it when you show the record.
          type: string
        subtype:
          type:
          - string
          - 'null'
        title:
          type: string
        type:
          enum:
          - rule
          - proposed_rule
          - notice
          - presidential
          - other
          type: string
        url:
          description: The record at its source; for a city record without a page of its own, the city's dataset.
          format: uri
          type:
          - string
          - 'null'
      required:
      - action
      - agencies
      - comments_close_date
      - comments_open
      - date
      - description
      - docket_ids
      - effective_date
      - id
      - place
      - reference
      - rins
      - significant
      - source
      - subtype
      - title
      - type
      - url
      type: object
  headers:
    X-RateLimit-Remaining:
      description: Requests this key has left today.
      schema:
        type: integer
    X-Noozra-Plan:
      description: 'The key''s plan: free (personal and non-commercial use) or pro (commercial use of the API).'
      schema:
        type: string
    X-RateLimit-Limit:
      description: Requests this key may make today. Sent on answers to a request with a key.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix time, in seconds, of the next 00:00 UTC, when every count starts again.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      description: 'API key (nk_…), from a free account: https://noozra.com/register?next=%2Faccount%2Fapi. A new free key needs a card saved to the account; saving it charges nothing. Free (100/day, personal and non-commercial use) or API Pro (25,000/day, commercial use of the API and the archive). Required on every request except /api/categories and /api/datasets.'
      scheme: bearer
      type: http
x-refined-from:
- noozra-openapi.json
- noozra-openapi.json