# HTML Form Label Link Auditor API ## Overview The HTML Form Label Link Auditor API checks how the labels in an HTML form connect to their controls. It reports labels whose target is missing, controls without a native label and duplicate IDs, with a row for every label and control. It is built for front-end developers, QA and accessibility teams who want a fast structural check of forms in templates or CI. It parses HTML with an HTML5 parser, treats scripts as inert and checks native elements only. ## Features * **1 endpoint**: `POST /v1/tools/html-form-label-link-auditor` with a JSON body. * **Label links**: explicit `for` and wrapping labels. * **Missing targets**: labels that point at no control. * **Duplicate IDs**: repeated IDs that make labels ambiguous. * **Up to 128 KiB**: of HTML per request. * **Output files**: reports come as base64 files in the JSON, each with its byte length and SHA-256 hash. * **Works on your data only**: it reads only what you send, fetches nothing and keeps no request data. * **Rate limit**: up to 2 requests per second on every plan. ## Use Cases * **Accessibility checks**: find unlabeled form fields. * **CI pipelines**: check templates on every change. * **QA**: audit forms before release. * **Template libraries**: lint shared form components. ## API Documentation ### Base URL All requests go through the API.market proxy at this base URL: ``` https://prod.api.market/api/v1/asl/html-form-label-link-auditor ``` ### Authentication Every request must include your API.market key in the `x-api-market-key` header: ``` x-api-market-key: YOUR_API_KEY ``` Replace `YOUR_API_KEY` with your actual API key. ### Endpoints #### 1. HTML Form Label Link Auditor The HTML Form Label Link Auditor API checks how the labels in an HTML form connect to their controls. **Method:** `POST` **Endpoint:** `/v1/tools/html-form-label-link-auditor` **Parameters:** | Name | In | Description | Type | Required | Default | Max Value | |---|---|---|---|---|---|---| | payload | body | Object that holds all the fields below | object | Yes | - | - | | payload.html | body | The HTML source to check | string | Yes | - | - | **Example Request:** ```bash curl -X POST 'https://prod.api.market/api/v1/asl/html-form-label-link-auditor/v1/tools/html-form-label-link-auditor' \ -H 'x-api-market-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "payload": { "html": "" } }' ``` **Example Response (200 OK):** ```json { "product": "html-form-label-link-auditor", "version": "1.0.0", "report": { "summary": { "controls": 3, "labels": 5, "unresolvedLabels": 3, "controlsWithoutNativeLabel": 1, "duplicateIds": 1 } }, "files": [ { "name": "LABELS.csv", "encoding": "base64", "bytes": 198, "sha256": "32ea9bce27876c90bc11fa6c69689fe6bee8518d0c514b694d20f18e87fad907", "data": "bGFiZWxJbmRleCxmb3JJZCxjb250cm9sSW5kZXgsYXNzb2NpYXRpb24sZHVwbGljYXRlVGFyZ2V0SWQNCjEsYSwxLGV4cGxpY2l0LEZhbHNlDQoyLCwyLHdyYXBwaW5nLEZhbHNlDQozLGdvbmUsLHRhcmdldC1taXNzaW5nLEZhbHNlDQo0LGR1cCwsdGFyZ2V0LW5vdC1sYWJlbGFibGUsVHJ1ZQ0KNSwsLG5vLXdyYXBw..." }, { "name": "CONTROLS.csv", "encoding": "base64", "bytes": 139, "sha256": "93b0d21cfce6620a57e8af529f79b87477aa32e5e3b1c46270273e9efe290121", "data": "Y29udHJvbEluZGV4LHRhZyxpZCxsYWJlbENvdW50LGxhYmVsSW5kaWNlcyxhcmlhTmFtaW5nQXR0cmlidXRlUHJlc2VudA0KMSxpbnB1dCxhLDEsMSxGYWxzZQ0KMixzZWxlY3QsY2l0eSwxLDIsRmFsc2UNCjMsaW5wdXQsZHVwLDAsLFRydWUNCg==" }, { "name": "DUPLICATES.csv", "encoding": "base64", "bytes": 23, "sha256": "60598bc81c64a933d5a86d1e5f3d0159ae42d3f0928dd3428981c6e68dbdcc6f", "data": "aWQsb2NjdXJyZW5jZXMNCmR1cCwyDQo=" } ] } ``` ## Status Codes | Code | Status | Description | |---|---|---| | 200 | OK | The request succeeded and the response body holds the result. | | 400 | Bad Request | A required parameter is missing or a value is invalid. Check the parameter table for the endpoint. | | 401 | Unauthorized | The `x-api-market-key` header is missing or the key is not valid. | | 403 | Forbidden | Your key is valid but your subscription does not allow this request, for example an endpoint outside your plan. | | 404 | Not Found | The path does not exist, or the resource you asked for was not found. | | 429 | Too Many Requests | You sent more than 2 requests per second. Slow down and retry, honouring the `Retry-After` header. | | 500 | Internal Server Error | Something went wrong while processing the request. Retry after a short wait. | | 503 | Service Unavailable | The service or its upstream data source is temporarily unavailable. Retry with backoff. | ## Rate Limits Every plan allows up to 2 requests per second. Subscription plans also have a monthly call quota shown on the pricing page. Sending more than 2 requests per second returns `429 Too Many Requests`. Throttle your client to stay under 2 requests per second, back off and retry when you get a 429, and honour the `Retry-After` header when it is present. ## FAQ * **Does it check the accessible name?** It reports native label links and whether ARIA naming attributes are present. Check the final accessible names in a browser. * **How do I read the output files?** Each entry in `files` has a `name`, base64 `data`, its `bytes` and a `sha256` hash. Decode `data` from base64, save it under `name`, and compare the hash if you need to verify it. * **Is my data stored?** No. The API processes the request and keeps no request data. * **What does a 400 INVALID_INPUT error mean?** The payload is missing a required field, has a wrong type or goes over a limit. Start from the example request and change one field at a time. ## Contact Us If you have any questions or need assistance, you can reach out to us through the embedded chat on the bottom right corner of the page or send an email to hello@magicapi.com.