/openfda/drug/labels

POST /api/openfda/drug/labels

Price: 1 credit

Get an FDA drug product label (SPL) by its SPL document id or SPL set id

How to use it

Get the full FDA structured product labeling (SPL) for a drug by its SPL document id or SPL set id. Returns the labeled sections — indications and usage, boxed warning, warnings, dosage and administration, contraindications, adverse reactions, drug interactions, active and inactive ingredients, purpose, clinical pharmacology and more — plus the openfda block (brand and generic names, manufacturer, NDC codes, route, pharmacologic class, RxCUI, UNII) and the effective date.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — SPL document id or SPL set id of the drug label (examples: "ca7bbcc8-2354-375c-e053-2995a90a72a0", "0000025c-6dbf-4af7-a741-5cbacaed519a"; minLength: 1)

Response

• @type string (default: "OpenfdaDrugLabel")
• id string required
• set_id string nullable
• version string nullable
• effective_at integer nullable
• indications_and_usage array (default: [])
• boxed_warning array (default: [])
• warnings array (default: [])
• warnings_and_cautions array (default: [])
• dosage_and_administration array (default: [])
• contraindications array (default: [])
• adverse_reactions array (default: [])
• drug_interactions array (default: [])
• active_ingredient array (default: [])
• inactive_ingredient array (default: [])
• purpose array (default: [])
• description array (default: [])
• clinical_pharmacology array (default: [])
• mechanism_of_action array (default: [])
• precautions array (default: [])
• general_precautions array (default: [])
• overdosage array (default: [])
• do_not_use array (default: [])
• ask_doctor array (default: [])
• when_using array (default: [])
• stop_use array (default: [])
• pregnancy array (default: [])
• pregnancy_or_breast_feeding array (default: [])
• nursing_mothers array (default: [])
• pediatric_use array (default: [])
• geriatric_use array (default: [])
• information_for_patients array (default: [])
• clinical_studies array (default: [])
• how_supplied array (default: [])
• keep_out_of_reach_of_children array (default: [])
• storage_and_handling array (default: [])
• questions array (default: [])
• spl_product_data_elements array (default: [])
• package_label_principal_display_panel array (default: [])
• openfda object nullable
  • @type string (default: "OpenfdaBlock")
  • application_number array (default: [])
  • brand_name array (default: [])
  • generic_name array (default: [])
  • manufacturer_name array (default: [])
  • product_ndc array (default: [])
  • package_ndc array (default: [])
  • product_type array (default: [])
  • route array (default: [])
  • substance_name array (default: [])
  • rxcui array (default: [])
  • unii array (default: [])
  • spl_id array (default: [])
  • spl_set_id array (default: [])
  • nui array (default: [])
  • pharm_class_cs array (default: [])
  • pharm_class_epc array (default: [])
  • pharm_class_moa array (default: [])
  • pharm_class_pe array (default: [])
  • is_original_packager array (default: [])
  • device_class string nullable
  • device_name string nullable
  • medical_specialty_description string nullable
  • regulation_number string nullable
  • fei_number array (default: [])
  • registration_number array (default: [])
  • k_number array (default: [])
  • pma_number array (default: [])
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Drug label not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.