{ "info": { "name": "EntropyAPI", "version": "v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Every EntropyAPI operation with a working example. Import the EntropyAPI environment, paste your API key into api_key, and send any request. Never share a collection or environment that holds a key." }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://api.entropyapi.io", "type": "string" } ], "item": [ { "name": "Drugs and products", "description": "Search drugs and products by name, or identify a pill from its imprint. Each result carries its full profile.", "item": [ { "name": "Identify pills", "request": { "method": "POST", "url": { "raw": "{{base_url}}/v1/pills/search", "host": [ "{{base_url}}" ], "path": [ "v1", "pills", "search" ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Find tablets and capsules by imprint, color, shape and other markings.\n\nOperation: PILL-SEARCH", "body": { "mode": "raw", "raw": "{\n \"imprint\": \"L484\",\n \"limit\": 5\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Search drugs", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/drugs/search?q=augmentin", "host": [ "{{base_url}}" ], "path": [ "v1", "drugs", "search" ], "query": [ { "key": "q", "value": "augmentin", "description": "A brand, ingredient or product name, such as Lipitor, atorvastatin or paracetamol. Strength and form words keep drugs with such a product, and combinations can be written in any order, such as hydrocodone/acetaminophen." }, { "key": "ingredient_rxcuis", "value": "", "disabled": true, "description": "Ingredient RxCUIs the drug must contain; composition_match says whether exactly these or at least these. Repeat the parameter to send more than one." }, { "key": "composition_match", "value": "", "disabled": true, "description": "exact: the drug’s ingredients are exactly ingredient_rxcuis. contains: the drug contains them, salts matched to their ingredient." }, { "key": "match_mode", "value": "", "disabled": true, "description": "How q is matched: auto (whole names and names starting with q) or exact (whole names only)." }, { "key": "limit", "value": "", "disabled": true, "description": "Results per page." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same search." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Find ingredient and multiple-ingredient drugs by official name, brand name or a marketed product’s name, or by ingredient composition. Each hit names its exact ingredients with their own RxCUIs, its brand names and dosage forms, and which name matched.\n\nOperation: DRUG-SEARCH" } }, { "name": "Retrieve a drug", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/drugs/:rxcui", "host": [ "{{base_url}}" ], "path": [ "v1", "drugs", ":rxcui" ], "query": [ { "key": "include", "value": "", "disabled": true, "description": "mechanism_of_action adds the mechanism of action from the label of FDA’s reference product. Repeat the parameter to send more than one." } ], "variable": [ { "key": "rxcui", "value": "19711", "description": "The RxNorm concept identifier of an ingredient, precise ingredient or combination." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Retrieve one drug by RxCUI, with what is marketed for it. A brand or product RxCUI returns its ingredient drug, and a retired RxCUI with one successor is redirected to it.\n\nOperation: DRUG-LOOKUP" } }, { "name": "Search products", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/marketed-products/search?q=amoxicillin", "host": [ "{{base_url}}" ], "path": [ "v1", "marketed-products", "search" ], "query": [ { "key": "q", "value": "amoxicillin", "description": "A proprietary, generic or ingredient name. Matching ignores case and punctuation. When no name holds q as written, its name words are searched in any order, and its strength and form words filter the products, as in Lisinopril 10 mg tablets. Send NDCs to CODE-LOOKUP." }, { "key": "match_mode", "value": "", "disabled": true, "description": "exact: the whole name. auto and prefix: names that start with the value, whole-name matches first." }, { "key": "drug_rxcui", "value": "", "disabled": true, "description": "Products DRUG-LOOKUP counts for this drug. Repeat for several, at most 20." }, { "key": "drug_group", "value": "", "disabled": true, "description": "Products in one of a drug’s form-and-strength groups (a group_key (fg_ and 32 hex digits) from DRUG-LOOKUP). Repeat for several, at most 20." }, { "key": "contains_substance", "value": "", "disabled": true, "description": "Products with this UNII as an ingredient in any role or as an active moiety, in the product or a kit part. Repeat for several, at most 20." }, { "key": "dosage_form", "value": "", "disabled": true, "description": "The product’s own SPL dosage-form code, a hit’s dosage_form.code. Codes match exactly: TABLET does not include TABLET, FILM COATED. Repeat for several, at most 20." }, { "key": "route", "value": "", "disabled": true, "description": "The product’s own SPL route code, a hit’s routes[].code. Repeat for several, at most 20." }, { "key": "labeler", "value": "", "disabled": true, "description": "A labeler name on the product’s label, matched under match_mode. Repeat for several, at most 20." }, { "key": "labeler_code", "value": "", "disabled": true, "description": "The NDC labeler code, the first part of the product NDC: 0003 or 50090. 00003 is the same as 0003. Repeat for several, at most 20." }, { "key": "brand_generic", "value": "", "disabled": true, "description": "Only brand products, or only generic ones (ANDA or NDA authorized generic)." }, { "key": "hide_repackagers", "value": "", "disabled": true, "description": "Leave out products whose label names another company’s source NDC or whose labeler declares a repack or relabel operation." }, { "key": "listing_status", "value": "", "disabled": true, "description": "current (default): active and unknown listings. active_listing: active only. all: every product, including ended and not_fda_listed." }, { "key": "limit", "value": "", "disabled": true, "description": "Products per page." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same search." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Find US products, one product NDC each, by name or by indexed facts: the drug they contain, a substance, dosage form, route, labeler, brand or generic, and listing status.\n\nOperation: MARKETED-PRODUCT-SEARCH" } } ] }, { "name": "Identifiers", "description": "Look up one code or resolve an ordered list of codes, including NDCs and scanner text.", "item": [ { "name": "Look up a code", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/codes/:code", "host": [ "{{base_url}}" ], "path": [ "v1", "codes", ":code" ], "query": [ { "key": "include", "value": "", "disabled": true, "description": "Narrows a one-product answer to the sections you name; repeat it or join names with commas, in any case. packages: the packages and their billing units. ingredients: the ingredients with classes, kit parts and excipient flags. labels: the labels. rating: the FDA rating. safety: recalls, shortages, REMS programs and recent safety labeling changes. Sections you don’t name are not read, and meta.sources lists only what was read. It applies only when the code resolves to one product and is ignored for every other answer. With no include you get the full profile." }, { "key": "limit", "value": "", "disabled": true, "description": "Products per page when an RxCUI, label set ID or application number names several, at most 100. Ignored for other answers." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same lookup’s products." } ], "variable": [ { "key": "code", "value": "0003-0894-21", "description": "An NDC in any layout, a GTIN or GS1 scanner text, an RxCUI, a UNII, a label set ID, or an NDA, ANDA or BLA number with its prefix, such as BLA125559 or NDA 020702 (a bare number is read as an RxCUI). Send scanner text that won’t fit in a URL path to GET /v1/codes/lookup?code=…. A code is 1 to 512 characters; spaces, tabs and line breaks at either end are ignored, and a blank code is 400. An NDC may carry an NDC prefix, spaces, dots or typographic dashes between its parts, zero padding (12 digits, or a 9-digit product) or dropped leading zeros. Send an NDC with its hyphens when you have them: unhyphenated 8, 10 and 11 digit forms can fit several layouts and be ambiguous (409). Spaces inside scanner text are data, so send it as scanned." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "One code in, what it names out. Accepted codes: an NDC in any layout, a GTIN or GS1 scanner text, an RxCUI, a UNII, a label set ID, or an NDA, ANDA or BLA number with its prefix, such as BLA125559 or NDA 020702 (a bare number is read as an RxCUI). A code that could be several types is tried as each.\n\nOperation: CODE-LOOKUP" } }, { "name": "Look up one code sent as a query parameter", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/codes/lookup?code=0003-0894-21", "host": [ "{{base_url}}" ], "path": [ "v1", "codes", "lookup" ], "query": [ { "key": "code", "value": "0003-0894-21", "description": "An NDC in any layout, a GTIN or GS1 scanner text, an RxCUI, a UNII, a label set ID, or an NDA, ANDA or BLA number with its prefix, such as BLA125559 or NDA 020702 (a bare number is read as an RxCUI). Send scanner text that won’t fit in a URL path to GET /v1/codes/lookup?code=…. A code is 1 to 512 characters; spaces, tabs and line breaks at either end are ignored, and a blank code is 400. An NDC may carry an NDC prefix, spaces, dots or typographic dashes between its parts, zero padding (12 digits, or a 9-digit product) or dropped leading zeros. Send an NDC with its hyphens when you have them: unhyphenated 8, 10 and 11 digit forms can fit several layouts and be ambiguous (409). Spaces inside scanner text are data, so send it as scanned." }, { "key": "include", "value": "", "disabled": true, "description": "Narrows a one-product answer to the sections you name; repeat it or join names with commas, in any case. packages: the packages and their billing units. ingredients: the ingredients with classes, kit parts and excipient flags. labels: the labels. rating: the FDA rating. safety: recalls, shortages, REMS programs and recent safety labeling changes. Sections you don’t name are not read, and meta.sources lists only what was read. It applies only when the code resolves to one product and is ignored for every other answer. With no include you get the full profile." }, { "key": "limit", "value": "", "disabled": true, "description": "Products per page when an RxCUI, label set ID or application number names several, at most 100. Ignored for other answers." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same lookup’s products." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "The same lookup as the path form, for scanner text or a code that does not fit in a URL path.\n\nOperation: CODE-LOOKUP" } }, { "name": "Resolve codes", "request": { "method": "POST", "url": { "raw": "{{base_url}}/v1/codes/resolve", "host": [ "{{base_url}}" ], "path": [ "v1", "codes", "resolve" ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Resolve 1 to 100 codes in one request, which counts as one against your allowance. Results keep your order and duplicates, and each one is compact: call CODE-LOOKUP for a result’s full profile.\n\nOperation: CODE-RESOLVE", "body": { "mode": "raw", "raw": "{\n \"codes\": [\n \"0003-0894-21\",\n \"19711\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Labels", "description": "Search current labels and retrieve their section text.", "item": [ { "name": "Search labels", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/labels/search?q=amoxicillin&document_type=prescription", "host": [ "{{base_url}}" ], "path": [ "v1", "labels", "search" ], "query": [ { "key": "q", "value": "amoxicillin", "description": "Text in the title, or a product, generic or ingredient name on the label. When nothing holds q as written, its name words are searched, and its strength and form words keep labels with such a product." }, { "key": "match_mode", "value": "", "disabled": true, "description": "auto (default): titles containing q, names starting with it, or every word in any order. prefix: titles and names starting with q. exact: the whole title or name." }, { "key": "drug_rxcui", "value": "", "disabled": true, "description": "Labels for products that contain this drug (an RxCUI from DRUG-SEARCH). Repeat the parameter to send more than one." }, { "key": "labeler", "value": "", "disabled": true, "description": "The labeler’s name. Repeat the parameter to send more than one." }, { "key": "document_type", "value": "prescription", "description": "prescription, otc, vaccine, plasma_derivative, allergenic or cellular_therapy. Repeat the parameter to send more than one." }, { "key": "hide_repackagers", "value": "", "disabled": true, "description": "true to leave out labels repackaged or relabeled from another company’s NDC." }, { "key": "limit", "value": "", "disabled": true, "description": "Labels per page." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same search." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Find current labels by title, product and ingredient names, drug, labeler and document type. Each hit lists the label’s products and flags.\n\nOperation: LABEL-SEARCH" } }, { "name": "Retrieve a label", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/labels/:set_id?section=warnings_and_cautions", "host": [ "{{base_url}}" ], "path": [ "v1", "labels", ":set_id" ], "query": [ { "key": "section", "value": "warnings_and_cautions", "description": "Section keys, LOINC codes or all, such as boxed_warning or 34066-1. all returns top-level sections; name a subsection to get it alone. A value that is neither a section key nor a well-formed LOINC code is a 400 whose details.supported lists the keys. Repeat the parameter to send more than one." } ], "variable": [ { "key": "set_id", "value": "e9481622-7cc6-418a-acb6-c5450daae9b0", "description": "The label set ID." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Retrieve a current label by set ID, or by an NDC it lists, with its sections. Name sections, or all, to get their text.\n\nOperation: LABEL-LOOKUP" } }, { "name": "Retrieve a label by set ID or NDC", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/labels/lookup?set_id=e9481622-7cc6-418a-acb6-c5450daae9b0§ion=warnings_and_cautions", "host": [ "{{base_url}}" ], "path": [ "v1", "labels", "lookup" ], "query": [ { "key": "set_id", "value": "e9481622-7cc6-418a-acb6-c5450daae9b0", "description": "The label set ID." }, { "key": "ndc", "value": "", "disabled": true, "description": "A product or package NDC, on GET /v1/labels/lookup in place of set_id. An NDC on several labels answers 409 ambiguous_identifier, with each label’s set_id and title in details.candidates." }, { "key": "section", "value": "warnings_and_cautions", "description": "Section keys, LOINC codes or all, such as boxed_warning or 34066-1. all returns top-level sections; name a subsection to get it alone. A value that is neither a section key nor a well-formed LOINC code is a 400 whose details.supported lists the keys. Repeat the parameter to send more than one." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Retrieve one current label by its set ID, or by an NDC it lists, sent as query parameters.\n\nOperation: LABEL-LOOKUP" } } ] }, { "name": "Recalls and safety", "description": "Check an inventory list against FDA recalls and shortages, or search recalls, shortages, REMS programs and safety labeling changes. The changes feed lists what is new.", "item": [ { "name": "Search recalls", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/recalls/search?q=amoxicillin&classification=Class%20II", "host": [ "{{base_url}}" ], "path": [ "v1", "recalls", "search" ], "query": [ { "key": "q", "value": "amoxicillin", "description": "Text ranked against the recall number, event ID, recalling firm, product description, reason, code information and distribution pattern. Every word matches at a word start, in any order, and openFDA’s harmonized brand and generic names also count. Send an FDA recall number, such as D-1039-2019, to find that recall; a recall number or event ID matches only whole. Results come by relevance, or newest report date first without q." }, { "key": "classification", "value": "Class II", "description": "Class I, Class II, Class III or Not Yet Classified. Repeat the parameter to send more than one." }, { "key": "enforcement_status_as_published", "value": "", "disabled": true, "description": "Ongoing, Completed or Terminated, as FDA published it. Pending is accepted, but FDA has published no Pending recall. Repeat the parameter to send more than one." }, { "key": "recalling_firm", "value": "", "disabled": true, "description": "Recalling firm names; a name matches whole, at its start or a word’s start (never inside a word), or word by word in any order, ignoring words like Inc or LLC. Repeat the parameter to send more than one." }, { "key": "initiated_from", "value": "", "disabled": true, "description": "Earliest recall initiation date, YYYY-MM-DD." }, { "key": "initiated_to", "value": "", "disabled": true, "description": "Latest recall initiation date, YYYY-MM-DD." }, { "key": "report_from", "value": "", "disabled": true, "description": "Earliest report date, YYYY-MM-DD." }, { "key": "report_to", "value": "", "disabled": true, "description": "Latest report date, YYYY-MM-DD." }, { "key": "ndc", "value": "", "disabled": true, "description": "Product or package NDCs in any layout, matched against the NDCs in the recall. Repeat the parameter to send more than one." }, { "key": "limit", "value": "", "disabled": true, "description": "Events per page." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same search." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Find FDA recall events by text (including a recall number), classification, status, firm, dates and NDC. Each hit is one event with a preview of its recalled products.\n\nOperation: RECALL-SEARCH" } }, { "name": "Retrieve a recall", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/recalls/:recall_id?product_limit=20", "host": [ "{{base_url}}" ], "path": [ "v1", "recalls", ":recall_id" ], "query": [ { "key": "product_limit", "value": "20", "description": "Products per page." }, { "key": "product_cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this event’s products." } ], "variable": [ { "key": "recall_id", "value": "recall_cca472456af5eeb39f4c6e55", "description": "The event identifier from RECALL-SEARCH. An FDA recall number is searched with RECALL-SEARCH’s q instead." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "One recall event with all of its recalled products, paged, newest report date first.\n\nOperation: RECALL-LOOKUP" } }, { "name": "Check inventory", "request": { "method": "POST", "url": { "raw": "{{base_url}}/v1/inventory/check", "host": [ "{{base_url}}" ], "path": [ "v1", "inventory", "check" ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Check 1 to 100 NDCs or barcodes, with lot numbers when you have them, against FDA recalls and shortages in one request, which counts as one against your allowance. Results keep your order. An empty list means none found; meta.warnings says what was searched.\n\nOperation: INVENTORY-CHECK", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"ndc\": \"0003-0894-21\",\n \"lot\": \"A1234\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Search shortages", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/shortages/search?q=Methotrexate", "host": [ "{{base_url}}" ], "path": [ "v1", "shortages", "search" ], "query": [ { "key": "q", "value": "Methotrexate", "description": "Text ranked against the generic name, proprietary name, presentation, company, shortage reason, manufacturer availability text and national status. Every word matches at a word start, in any order, and openFDA’s harmonized names also count. Results come by relevance, or most recently updated first without q." }, { "key": "shortage_id", "value": "", "disabled": true, "description": "Shortage IDs, matched exactly. Supplying one lifts the status default unless national_shortage_status is set. Repeat the parameter to send more than one." }, { "key": "company", "value": "", "disabled": true, "description": "Company names, matched whole after case, punctuation and words like Inc, LLC or USA are ignored. Repeat the parameter to send more than one." }, { "key": "national_shortage_status", "value": "", "disabled": true, "description": "current, resolved, to_be_discontinued or all; the default is current and to_be_discontinued. Send all on its own. Repeat the parameter to send more than one." }, { "key": "therapeutic_category", "value": "", "disabled": true, "description": "FDA therapeutic categories, such as Oncology or Anesthesia, in any case. Several values match any of them. Repeat the parameter to send more than one." }, { "key": "updated_from", "value": "", "disabled": true, "description": "Earliest update date, YYYY-MM-DD." }, { "key": "updated_to", "value": "", "disabled": true, "description": "Latest update date, YYYY-MM-DD." }, { "key": "package_ndc", "value": "", "disabled": true, "description": "Package NDCs in any layout, matched against the shortage’s package NDC. Repeat the parameter to send more than one." }, { "key": "limit", "value": "", "disabled": true, "description": "Presentations per page." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same search." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Find FDA drug shortage presentations by text, company, status, therapeutic category, update dates and package NDC. The default view is current and to-be-discontinued shortages; a presentation ID reaches a resolved one.\n\nOperation: SHORTAGE-SEARCH" } }, { "name": "Search REMS programs", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/rems-programs/search?requirement=patient_enrollment", "host": [ "{{base_url}}" ], "path": [ "v1", "rems-programs", "search" ], "query": [ { "key": "q", "value": "", "disabled": true, "description": "Text ranked against the program name and its covered products’ established and trade names; a match may be a whole name, a word’s start (never inside a word), or every name word in any order. REMS, form and strength words are optional." }, { "key": "status", "value": "", "disabled": true, "description": "current (the default), inactive, released or moved_to_shared_system; several values combine. Repeat the parameter to send more than one." }, { "key": "requirement", "value": "patient_enrollment", "description": "Requirement flags the program must have, all of them: medication_guide, communication_plan, elements_to_assure_safe_use, implementation_system, prescriber_certification, dispenser_certification, patient_enrollment or prescriber_training. Repeat the parameter to send more than one." }, { "key": "limit", "value": "", "disabled": true, "description": "Programs per page." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same search." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Find FDA REMS programs by name or covered product and by requirement flags. Each program is what its latest version says; current programs only unless status asks for others.\n\nOperation: REMS-SEARCH" } }, { "name": "Retrieve a REMS program", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/rems-programs/:rems_id", "host": [ "{{base_url}}" ], "path": [ "v1", "rems-programs", ":rems_id" ], "query": [ { "key": "product_limit", "value": "", "disabled": true, "description": "Covered products per page." }, { "key": "product_cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this program’s products." } ], "variable": [ { "key": "rems_id", "value": "rems_395", "description": "The program identifier from REMS-SEARCH, such as rems_24; FDA’s bare REMS ID (24) also works." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "One REMS program with its covered products, paged; or, by NDC, the current program covering that product’s FDA application. A bad NDC is refused before the REMS data is read; a missing REMS release is a 503 naming the dataset rems.\n\nOperation: REMS-LOOKUP" } }, { "name": "Retrieve a REMS program by ID or NDC", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/rems-programs/lookup?rems_id=rems_395", "host": [ "{{base_url}}" ], "path": [ "v1", "rems-programs", "lookup" ], "query": [ { "key": "rems_id", "value": "rems_395", "description": "The program identifier from REMS-SEARCH, such as rems_24; FDA’s bare REMS ID (24) also works." }, { "key": "ndc", "value": "", "disabled": true, "description": "A product or package NDC, on GET /v1/rems-programs/lookup in place of rems_id. Returns the current program for its FDA application." }, { "key": "product_limit", "value": "", "disabled": true, "description": "Covered products per page." }, { "key": "product_cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this program’s products." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Retrieve one REMS program by its ID, or by an NDC it covers, sent as query parameters.\n\nOperation: REMS-LOOKUP" } }, { "name": "Safety labeling changes", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/safety-labeling-changes/search?q=amoxicillin", "host": [ "{{base_url}}" ], "path": [ "v1", "safety-labeling-changes", "search" ], "query": [ { "key": "q", "value": "amoxicillin", "description": "Text matched against the drug and active-ingredient names; every word must match as a whole word, leaving out strength, form and words like label or change. Results come newest change first." }, { "key": "change_id", "value": "", "disabled": true, "description": "Change IDs, in any letter case. Repeat the parameter to send more than one." }, { "key": "application_number", "value": "", "disabled": true, "description": "FDA application numbers, such as NDA 020702. A number alone matches any type. Repeat the parameter to send more than one." }, { "key": "section", "value": "", "disabled": true, "description": "A section code (5), title (Warnings and Precautions) or FDA’s abbreviation (WP). Repeat for several." }, { "key": "changed_from", "value": "", "disabled": true, "description": "Earliest FDA change date, YYYY-MM-DD." }, { "key": "changed_to", "value": "", "disabled": true, "description": "Latest FDA change date, YYYY-MM-DD." }, { "key": "include", "value": "", "disabled": true, "description": "section_text adds each section’s full text; source_formatting adds it with FDA’s underline spans. Repeat the parameter to send more than one." }, { "key": "limit", "value": "", "disabled": true, "description": "Changes per page." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same search." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Find FDA-designated safety labeling changes by drug, application, section and date. Each hit is one application-supplement change; each changed section shows the wording FDA underlined as new. A generic FDA lists nothing for shows its reference drug’s changes, marked as such.\n\nOperation: SAFETY-LABEL-CHANGE-SEARCH" } }, { "name": "Changes feed", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/safety-events/changes?since=2026-10-01", "host": [ "{{base_url}}" ], "path": [ "v1", "safety-events", "changes" ], "query": [ { "key": "since", "value": "2026-10-01", "description": "Changes first seen at or after this time (inclusive): a date, YYYY-MM-DD, which is midnight UTC so the whole day is kept, or an ISO date-time with a zone." }, { "key": "family", "value": "", "disabled": true, "description": "recalls or shortages. Repeat for both; leave it out for both." }, { "key": "record_id", "value": "", "disabled": true, "description": "One record’s changes: the record_id of an earlier change, or a recall number such as D-0645-2024 for every product of that recall. An ID no record carries is 404; one from a family you did not ask for is 400." }, { "key": "limit", "value": "", "disabled": true, "description": "Changes per page." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same feed." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "What changed in FDA recalls and shortages, newest first. Each change includes the full record, the time we first saw it and FDA’s own dates.\n\nOperation: SAFETY-EVENT-CHANGES" } } ] }, { "name": "Interchangeability", "description": "Check whether FDA rates two products interchangeable, and list the products it rates interchangeable with one.", "item": [ { "name": "List alternatives", "request": { "method": "GET", "url": { "raw": "{{base_url}}/v1/interchangeability/alternatives?code=0074-5182", "host": [ "{{base_url}}" ], "path": [ "v1", "interchangeability", "alternatives" ], "query": [ { "key": "code", "value": "0074-5182", "description": "A code for one product: a product or package NDC, a GTIN or GS1 scanner text. A label set ID, application number or RxCUI that carries exactly one product is accepted. A code that names several products, or a Drug, answers 409 with candidates to choose from. A retired RxCUI is 410, an RxCUI RxNorm’s history does not cover is 404, and one that is not a drug is 422." }, { "key": "include_not_interchangeable", "value": "", "disabled": true, "description": "Also list products under the same FDA heading or reference product that FDA does not rate interchangeable, flagged by interchangeable and outcome." }, { "key": "limit", "value": "", "disabled": true, "description": "Alternatives per page, at most 100." }, { "key": "cursor", "value": "", "disabled": true, "description": "The cursor from the previous page of this same listing." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "A product code returns the product’s FDA rating and the marketed products FDA rates interchangeable with it, one per product NDC. The product’s own application decides the book: a BLA reads the Purple Book, an NDA or ANDA the Orange Book. A page can be short, even empty, while next_cursor is set; keep paging. A subject no book rates answers 200 with an empty list, which does not mean none exist.\n\nOperation: INTERCHANGEABILITY-ALTERNATIVES" } }, { "name": "Check two products", "request": { "method": "POST", "url": { "raw": "{{base_url}}/v1/interchangeability/check", "host": [ "{{base_url}}" ], "path": [ "v1", "interchangeability", "check" ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "", "disabled": true, "description": "Makes a retry count once. 8 to 128 letters, digits and . _ : / + -, starting with a letter or digit. For 24 hours the key is bound to your workspace and the exact request; reusing it for different work is refused with 409." } ], "description": "Two product codes return whether FDA rates the products interchangeable, with the outcome, the reason and each product’s own rating. subject is the product of code; swapping the codes swaps subject and comparator and keeps the verdict, including the reason.\n\nOperation: INTERCHANGEABILITY-CHECK", "body": { "mode": "raw", "raw": "{\n \"code\": \"0074-5182\",\n \"compare_with\": \"60793-852\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }