{
  "openapi": "3.0.1",
  "info": {
    "title": "Federal Register Deadline Monitor",
    "description": "Find open Federal Register comment deadlines and effective dates from the official Federal Register API.",
    "version": "0.1",
    "x-build-id": "uDLWLiQeK0EG1QtaB"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/challenge_logic~federal-register-deadline-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-challenge_logic-federal-register-deadline-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/challenge_logic~federal-register-deadline-monitor/runs": {
      "post": {
        "operationId": "runs-sync-challenge_logic-federal-register-deadline-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/challenge_logic~federal-register-deadline-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-challenge_logic-federal-register-deadline-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "query": {
            "title": "Search query",
            "type": "string",
            "description": "Keyword or phrase to search in Federal Register documents."
          },
          "agencies": {
            "title": "Agency slugs",
            "type": "array",
            "description": "Optional FederalRegister.gov agency slugs, such as environmental-protection-agency or food-and-drug-administration.",
            "items": {
              "type": "string"
            }
          },
          "documentTypes": {
            "title": "Document types",
            "type": "array",
            "description": "Filter by Federal Register document category.",
            "items": {
              "type": "string",
              "enum": [
                "RULE",
                "PRORULE",
                "NOTICE",
                "PRESDOCU"
              ],
              "enumTitles": [
                "Rule",
                "Proposed Rule",
                "Notice",
                "Presidential Document"
              ]
            }
          },
          "publicationDateFrom": {
            "title": "Publication date from",
            "type": "string",
            "description": "Only include documents published on or after this date, in YYYY-MM-DD format."
          },
          "publicationDateTo": {
            "title": "Publication date to",
            "type": "string",
            "description": "Only include documents published on or before this date, in YYYY-MM-DD format."
          },
          "deadlineDateFrom": {
            "title": "Deadline date from",
            "type": "string",
            "description": "Only include rows with a comment/effective deadline on or after this date. Leave blank to use today when Only upcoming is enabled."
          },
          "deadlineDateTo": {
            "title": "Deadline date to",
            "type": "string",
            "description": "Only include rows with a comment/effective deadline on or before this date."
          },
          "includeCommentDeadlines": {
            "title": "Comment deadlines",
            "type": "boolean",
            "description": "Include documents with public comment close dates.",
            "default": true
          },
          "includeEffectiveDates": {
            "title": "Effective dates",
            "type": "boolean",
            "description": "Include documents with effective dates.",
            "default": true
          },
          "onlyWithDeadlines": {
            "title": "Only rows with deadlines",
            "type": "boolean",
            "description": "Skip documents that have no selected deadline date.",
            "default": true
          },
          "onlyUpcoming": {
            "title": "Only upcoming deadlines",
            "type": "boolean",
            "description": "Skip documents whose selected deadline dates are all before today.",
            "default": true
          },
          "emitOnlyNew": {
            "title": "Emit only new documents",
            "type": "boolean",
            "description": "If enabled, skip document numbers provided in seenDocumentNumbers or loaded from stateKey.",
            "default": false
          },
          "seenDocumentNumbers": {
            "title": "Already seen document numbers",
            "type": "array",
            "description": "Optional document numbers to treat as already seen.",
            "items": {
              "type": "string"
            }
          },
          "stateKey": {
            "title": "State key",
            "type": "string",
            "description": "Optional Apify key-value store key for persisted seen document numbers."
          },
          "sort": {
            "title": "Sort order",
            "enum": [
              "newest",
              "oldest",
              "relevance"
            ],
            "type": "string",
            "description": "Federal Register API result order.",
            "default": "newest"
          },
          "maxResults": {
            "title": "Maximum saved rows",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Maximum number of rows to save to the dataset.",
            "default": 100
          },
          "maxPages": {
            "title": "Maximum API pages",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Safety cap for Federal Register API pages fetched. Each page fetch is delayed politely.",
            "default": 10
          },
          "requestDelaySeconds": {
            "title": "Request delay seconds",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Pause between API page requests.",
            "default": 0.25
          },
          "today": {
            "title": "Today override",
            "type": "string",
            "description": "Optional YYYY-MM-DD date for reproducible tests. Leave blank in normal runs."
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}