Supplement Check

A supplement's label: amounts per serving, upper limit check, halal status and a buy link. For requests like "what's in Nature Made vitamin D3?", "is Centrum halal?", "how much melatonin is in OLLY Sleep?" or "is this supplement halal?" with a barcode. Give q (brand and product name) or barcode. Returns per-serving amounts, dose_check (each vitamin and mineral compared with the adult upper limit at the most the label suggests per day, with per_day_base amounts), other_checks (melatonin, caffeine, creatine, ashwagandha and similar, including when a blend hides the amount), halal (likely_halal, doubtful, not_halal or depends_on_school, with the ingredients that need a confirmed source), alternatives (other sizes or versions), an Amazon link, and halal_options (links to halal-certified or gelatine-free versions) when the halal answer is not likely_halal. For a general name like "creatine monohydrate" it reads one common label and says so. With country=GB, dose_check uses the NHS guidance where it sets one (upper_limit says NHS guidance). Salt forms such as magnesium glycinate are counted as the mineral they hold (estimated: true), and omega-3 is read from EPA and DHA, total omega-3, or estimated from the fish oil weight.

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "description": "Brand and product name, for example Nature Made vitamin D3 2000 IU."
    },
    "barcode": {
      "type": "string",
      "description": "UPC or EAN barcode digits (8 to 14)."
    },
    "id": {
      "type": "integer",
      "description": "A label id from the NIH database, for example from alternatives."
    },
    "country": {
      "type": "string",
      "description": "US, GB, IE, CA, AU. GB uses NHS guidance for the dose checks; also picks the buy link site. Default from the request."
    }
  },
  "required": [],
  "additionalProperties": false
}

What a vitamin, mineral or popular supplement does, how much adults need or studies used, limits, cautions and food sources. For requests like "what does magnesium glycinate do?", "what is vitamin K for?", "how much vitamin D do I need?", "is ashwagandha safe?" or "what is creatine?". Covers vitamins A, B1, B2, B5, B6, B12, C, D, E and K, niacin, folate, biotin, choline, calcium, iron, zinc, magnesium, potassium, selenium, iodine, copper, chromium, manganese, molybdenum, phosphorus, boron and omega-3, and explains common forms. Also covers creatine, melatonin, caffeine, ashwagandha, turmeric, CoQ10, collagen, protein powder, probiotics, psyllium, glucosamine, St John's wort, green tea extract, berberine, L-theanine and elderberry: for these it returns supplement, what_studies_looked_at, studied_amounts, ceiling, cautions and source instead of rda and upper_limit. Links the NIH fact sheet. With country=GB the answer gives the UK amounts and NHS supplement guidance, also in the uk field.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "A vitamin, mineral, form or supplement, for example magnesium glycinate or ashwagandha."
    },
    "country": {
      "type": "string",
      "description": "US, GB, IE, CA, AU. GB gives UK (NHS) amounts; also picks the shop link site. Default from the request."
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Compare an amount of a vitamin or mineral with the adult RDA and upper limit. For requests like "is 5000 IU of vitamin D too much?", "is 500 mg of magnesium glycinate safe?", "is 10 mg of melatonin a lot?" or "is 300 mg of caffeine too much?". Handles IU, mcg, mg and g, including IU for vitamins A, D and E and DFE for folate. For vitamins and minerals, status is above, at, within or no_upper_limit; when the name is a compound (magnesium glycinate, ferrous sulfate, zinc gluconate) the `compound` field also gives how much of the mineral the compound holds, as US and UK labels list the mineral itself; when only one reading is over the limit, the say line gives both and compared_with.depends_on_label is true. Fish oil, cod liver oil and krill oil amounts are the oil weight, so EPA plus DHA is estimated (amount.epa_dha_estimate_mg). With country=GB the limit is the NHS guidance (compared_with.reference is UK (NHS), with us_upper_limit alongside). For other supplements the answer compares with an official ceiling where one exists (caffeine) or the amounts studies have used, with status above, at, within, above_studied_range, within_studied_range, below_studied_range or no_set_amount, plus cautions. Adult values only, with a note.

{
  "type": "object",
  "properties": {
    "nutrient": {
      "type": "string",
      "description": "The vitamin, mineral or supplement, for example vitamin D, magnesium or melatonin."
    },
    "amount": {
      "type": "number",
      "minimum": 0,
      "maximum": 10000000,
      "description": "The amount taken per day, in the unit given."
    },
    "unit": {
      "type": "string",
      "description": "IU, mcg, mg, g, mcg DFE, or billion (CFU) for probiotics. Defaults to IU for vitamin D amounts of 200 or more, otherwise the usual unit."
    },
    "q": {
      "type": "string",
      "description": "The whole question instead, for example 5000 IU vitamin D."
    },
    "country": {
      "type": "string",
      "description": "Two-letter country code. GB compares with NHS guidance and gives UK amounts. Default from the request."
    }
  },
  "required": [],
  "additionalProperties": false
}

Add up everything someone takes and check the daily totals against adult upper limits. For requests like "I take Centrum, vitamin D 5000 IU and zinc 50 mg, is that too much?" or "is it OK to take OLLY Sleep with extra melatonin?". Takes up to 6 items separated by semicolons: product names, barcodes, or amounts like vitamin D 5000 IU. Products are counted at the most each label suggests per day. Returns totals (each vitamin and mineral added up, with the items it comes from, compared with the adult upper limit, or NHS guidance with country=GB), other_totals (caffeine, melatonin and similar added up, or marked when a label hides the amount), items (what each was matched to) and not_found. Fish oil amounts count the EPA and DHA they typically hold.

{
  "type": "object",
  "properties": {
    "items": {
      "type": "string",
      "description": "What the user takes, separated by semicolons, for example Centrum Silver Men; vitamin D 5000 IU; zinc 50 mg."
    },
    "country": {
      "type": "string",
      "description": "Two-letter country code. GB compares totals with NHS guidance. Default from the request."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}