openfda_search_drug_shortages

Parameters schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "skip": {
      "type": "number",
      "default": 0,
      "maximum": 25000,
      "minimum": 0,
      "description": "Number of records to skip for pagination (0-25000, default 0)"
    },
    "sort": {
      "type": "string",
      "description": "Sort expression (field:asc or field:desc). Example: update_date:desc. Invalid or non-sortable fields cause a query error — use a documented field name."
    },
    "limit": {
      "type": "number",
      "default": 10,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number of records to return (1-1000, default 10)"
    },
    "search": {
      "type": "string",
      "description": "openFDA search query using field:value syntax. Examples: status:\"Current\", therapeutic_category:\"Oncology\", generic_name:\"carboplatin\", company_name:\"pfizer\". Omit to browse all records. Call openfda_describe_fields({ endpoint: \"drug/shortages\" }) for the complete field list."
    },
    "canvas_id": {
      "type": "string",
      "description": "DataCanvas session id from a prior call. Omit to start a fresh canvas; the response returns a new one when canvas is enabled. When canvas (CANVAS_PROVIDER_TYPE=duckdb) is enabled the full matched set is staged for SQL and limit/skip apply only to the inline path."
    }
  }
}

• Data resourceopenFDA API

  FDA · science

  name mention0.85

Parent server