{
  "openapi": "3.0.1",
  "info": {
    "title": "ADA Title II Accessibility Checker: WCAG and PDF",
    "description": "Returns one row per page with its WCAG 2.1 AA violations (axe-core, desktop and mobile), every linked PDF with its tagging status, and a printable ADA Title II readiness report with a score per site. For city, county, school and state websites. Not legal advice.",
    "version": "0.2",
    "x-build-id": "qhqvwJ1OaK3v3Fwuh"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/omargnagy~ada-title-ii-scanner/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-omargnagy-ada-title-ii-scanner",
        "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/omargnagy~ada-title-ii-scanner/runs": {
      "post": {
        "operationId": "runs-sync-omargnagy-ada-title-ii-scanner",
        "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/omargnagy~ada-title-ii-scanner/run-sync": {
      "post": {
        "operationId": "run-sync-omargnagy-ada-title-ii-scanner",
        "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": {
          "domain": {
            "title": "Website to scan",
            "type": "string",
            "description": "A domain such as cityofexample.gov, or a page to start from. Separate several sites with commas to get one report per site."
          },
          "maxPages": {
            "title": "Maximum pages per site",
            "minimum": 1,
            "maximum": 250,
            "type": "integer",
            "description": "How many pages to load and test per site, up to 250. Pages that fail to load or return an HTTP error are listed and not charged.",
            "default": 100
          },
          "includePdfInventory": {
            "title": "Check linked PDFs",
            "type": "boolean",
            "description": "Download every PDF linked from a scanned page and check its tags, structure tree, text layer and page count. Turn off for a pages-only scan.",
            "default": true
          },
          "maxPdfs": {
            "title": "Maximum PDFs per site",
            "minimum": 0,
            "maximum": 2000,
            "type": "integer",
            "description": "How many PDFs to check per site. The report still counts every PDF link it found and says when the list is a sample.",
            "default": 200
          },
          "viewports": {
            "title": "Screen sizes",
            "type": "array",
            "description": "Desktop is 1366 x 900, mobile is 390 x 844. A page is charged once, however many sizes are tested.",
            "items": {
              "type": "string",
              "enum": [
                "desktop",
                "mobile"
              ],
              "enumTitles": [
                "Desktop, 1366 x 900",
                "Mobile, 390 x 844"
              ]
            },
            "default": [
              "desktop",
              "mobile"
            ]
          },
          "population": {
            "title": "Entity population",
            "minimum": 0,
            "type": "integer",
            "description": "Total population of the city, county or district. The report then states which ADA Title II date applies: 26 April 2027 at 50,000 or more, 26 April 2028 below that."
          },
          "entityName": {
            "title": "Entity name",
            "type": "string",
            "description": "The name printed on the report, for example City of Example. Defaults to the domain."
          },
          "populationSource": {
            "title": "Population source",
            "type": "string",
            "description": "Where the population figure came from, printed next to it so the number is traceable."
          },
          "preparedBy": {
            "title": "Prepared by",
            "type": "string",
            "description": "Your organization's name, printed at the foot of every report. Empty by default."
          },
          "contact": {
            "title": "Contact line",
            "type": "string",
            "description": "A contact line printed at the foot of every report, for example an email for questions about it. Empty by default."
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Pages to start from, one per line, when navigation hides a section. Pages on the same host share one report. Replaces Website to scan when filled.",
            "items": {
              "type": "string"
            }
          },
          "includeSubdomains": {
            "title": "Follow subdomains",
            "type": "boolean",
            "description": "Also crawl subdomains of the site, where agenda portals and payment pages often live. Off scans the exact host only.",
            "default": true
          },
          "wcagTags": {
            "title": "axe-core rule tags",
            "type": "array",
            "description": "Which axe-core rule sets to run. The default is WCAG 2.0 and 2.1 at levels A and AA, the standard the rule names. Add wcag22aa for WCAG 2.2 or best-practice for advisory checks.",
            "default": [
              "wcag2a",
              "wcag2aa",
              "wcag21a",
              "wcag21aa"
            ],
            "items": {
              "type": "string"
            }
          },
          "maxPdfMegabytes": {
            "title": "PDF size ceiling (MB)",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "PDFs larger than this are listed with their size and date but not downloaded or charged.",
            "default": 25
          },
          "takeScreenshots": {
            "title": "Save screenshots",
            "type": "boolean",
            "description": "Save one JPEG per page per screen size, linked from the report as evidence.",
            "default": true
          },
          "screenshotFullPage": {
            "title": "Full-page screenshots",
            "type": "boolean",
            "description": "Capture the whole scrollable page instead of the visible area. Several times larger.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Pages at once",
            "minimum": 1,
            "maximum": 8,
            "type": "integer",
            "description": "How many pages load at the same time. The default of 1 protects small public servers. Raise it, up to 8, only for a site that can take it.",
            "default": 1
          },
          "crawlDelaySecs": {
            "title": "Seconds between requests",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Gap between requests to one host, and between PDF downloads. If robots.txt asks for a longer Crawl-Delay, the site's number wins (up to 120 seconds).",
            "default": 1
          },
          "respectRobotsTxt": {
            "title": "Obey robots.txt",
            "type": "boolean",
            "description": "Leave on. Disallow rules are then obeyed for pages and PDFs. A Crawl-Delay is always honoured.",
            "default": true
          },
          "userAgent": {
            "title": "User agent",
            "type": "string",
            "description": "How the scanner identifies itself to each site. The default links to this Actor's page so a site operator can see who crawled them.",
            "default": "Mozilla/5.0 (compatible; ADATitleIIScanner/0.2; +https://apify.com/omargnagy/ada-title-ii-scanner)"
          },
          "useApifyProxy": {
            "title": "Use Apify Proxy",
            "type": "boolean",
            "description": "Load pages through Apify's datacenter proxy. robots.txt and PDF downloads go direct from the run. Residential proxies are never used.",
            "default": true
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}