Login
Toggle sidebar

Linter API

Lint any Radiopaedia article over HTTP and get the results back as JSON. No authentication; the standard API rate limit applies.

GET https://radiopaedia.work/api/v1/lint?article=pneumothorax
Parameters
Name
Required
Description
article Yes The article to lint, as an rID, a slug, or a full Radiopaedia URL. Remember to URL-encode a full URL.
type No The article type to validate headings against. Omit it and the type is detected from the article's own headings. See the table below.
cache No Pass refresh to refetch the article from Radiopaedia instead of using the cached copy.
Response

200 with the lints, 404 if the article has no content, or 422 if article is missing.

{
  "slug": "pneumothorax",
  "article_type": "general",
  "counts": { "error": 1, "suggestion": 3 },
  "lints": [
    {
      "line": 12,
      "position": 16,
      "message": "Use 'does not' instead of 'doesn't'.",
      "severity": "error",
      "condition": "Radiopaedia.Contractions",
      "matched": "doesn't",
      "match": "<p>The patient doesn't have symptoms.</p>",
      "trimmed": "The patient doesn't have symptoms.",
      "display": "The patient <mark>doesn't</mark> have symptoms.",
      "supportsExceptions": false
    }
  ]
}

condition is the rule that fired; see current rules for the full list. display is the offending line with most HTML stripped, ready to show to a human, with the matched span wrapped in a <mark> so it can be highlighted.

Article types

Each type carries an expected heading outline. Only headings are checked against it; the prose rules run the same either way. Total counts every permitted heading across all three levels.

Type
Total
Top-level headings
general 41 Terminology, Usage, Epidemiology, Clinical presentation, Diagnosis, Pathology, Radiographic features, Radiology report, Treatment and prognosis, History and etymology, Differential diagnosis, Practical points, See also
fracture 9 Epidemiology, Mechanism, Radiographic features, Treatment and prognosis, History and etymology, See also
anatomy_general 24 Summary, Gross anatomy, Arterial supply, Venous drainage, Lymphatic drainage, Innervation, Histology, Variant anatomy, Radiographic features, Development, Clinical importance, Related pathology, History and etymology, See also
anatomy_organ 24 Summary, Gross anatomy, Arterial supply, Venous drainage, Lymphatic drainage, Innervation, Histology, Variant anatomy, Radiographic features, Development, Clinical importance, Related pathology, History and etymology, See also
anatomy_vessel 20 Summary, Gross anatomy, Variant anatomy, Radiographic features, Development, Clinical importance, Related pathology, History and etymology, See also
anatomy_nerve 20 Summary, Gross anatomy, Variant anatomy, Radiographic features, Development, Clinical importance, Related pathology, History and etymology, See also
anatomy_bone 20 Gross anatomy, Arterial supply, Venous drainage, Innervation, Summary, Variant anatomy, Radiographic features, Development, Clinical importance, Related pathology, History and etymology, See also
biographical 5 Early life, Later life, Legacy, See also
chemical 16 Chemistry, Nutrition, absorption, transport and storage, Biological function, Deficiency, Toxicity, Clinical importance, Radiological importance, History and etymology, Related pathology, See also
classification 5 Usage, Classification, History and etymology, Related pathology, See also
approach 8 Clinical information, Protocol, Normal appearance, Approach, Related pathology, Radiology report, Practical points, Summary
imaging_technology 21 Terminology, Clinical applications, Technique, Interpretation, History and etymology, Practical points, Related articles, See also
procedure 13 Indications, Contraindications, Preprocedural evaluation, Procedure, Postprocedural evaluation, Complications, Outcomes, History and etymology, See also
measurement 5 Usage, Measurement, Interpretation, History and etymology, See also
ct_protocol 14 Indications, Contraindications, Technique, Practical points, Post-processing, Related articles, See also
mri_protocol 14 Indications, 1.5 vs 3 tesla, Patient preparation, Patient positioning, Technical parameters, Sequences, Practical points, Related articles, See also
radiography_series 9 Indications, Projections, Procedure, See also
radiography_view 6 Indications, Patient position, Technical factors, Image technical evaluation, Practical points, See also
summary 5 Reference article, Summary, Role of imaging, Radiographic features, See also