Iodine API documentation

Use the Iodine API to include our user-friendly drug information and user ratings in your product or service. You must provide credit to and links back to Iodine, and be thoughtful about how you use the data—it’s sensitive health information. Read through this guide to learn how to use the API and about the JSON return.

If you use the Iodine API, you agree to abide by the Iodine API terms of use.

A quick review of the terms of use

Give us credit. Wherever you display Iodine content, you must also link back to Iodine using the link supplied in the API. You must also give us credit, either by prominently displaying our logo or including text that says “Powered by Iodine” or similar. Also, you should never claim ownership, responsibility or sponsorship for Iodine Content.

Do not store Iodine data. The API is for real time user-driven requests. Don’t capture or download information from the API for later use.

Be consumer-facing. You must obtain our prior written consent if you want to use Iodine information for non-consumer purposes.

Integrate us to add value. Do not use the API to recreate what Iodine’s own website or mobile apps already offer. If that’s what you’re after, simply link to Iodine or request deeper site integration.

Enable links. Do not disable your links to Iodine. When using our API and Iodine branded images, you must link back to Iodine.

Leave our data and content alone. You may not alter our data or combine it with other data. You may not alter our logo, graphics, or Iodine Content.

For mobile. Have clear Iodine branding on the app/mobile pages where you are using and/or incorporating Iodine content. On platforms where Iodine also has a mobile application, we may require you to link directly to our application instead of our mobile site.

Using your API key

You’ll have gotten an API key from us by email. You must include this API key with each API request, by passing a parmeter as a http header variable, x-api-key.

Here is an example of setting the header key in a Javascript request, calling the drug endpoint to get data about the drug Zoloft (Sertraline) and grabbing a piece of the result. In this example, you would replace your-api-key-here with your API key.

var xhr = new XMLHttpRequest();
xhr.open('GET', 'https://api.iodine.com/drug/effexor.json', false);
xhr.setRequestHeader('x-api-key', 'your-api-key-here');
xhr.send();
var drug = JSON.parse(xhr.response);
console.log("Drug full name: ", drug.name.full);

Looking up drugs

Find drugs in the Iodine API by name. Which name? We’ve got a special lookup for that. It returns a JSON directory of all the drugs in our API—where each drug is keyed to its canonical name, and lists the other names associated with the drug along with other helpful identifiers, like drug category or class. You need an API key to use this lookup, but here’s a snippet for one medication—Effexor (venlafaxine).

https://api.iodine.com/drug/index.json
"effexor": {
  "name": {
    "generic": "Venlafaxine",
    "brand": [
      "Effexor",
      "Effexor XR"
    ],
    "common": "Venlafaxine"
  },
  "category": {
    "name": "Mental health",
    "subcategories": [
      {
        "name": "Antidepressant",
        "subcategories": [
          {
            "name": "Serotonin-norepinephrine reuptake inhibitor (SNRI)"
          }
        ]
      }
    ]
  },
  "genericAvailable": true,
  "onLabel": [
    "Depression",
    "Anxiety",
    "Social anxiety",
    "Panic disorder"
  ],
  "offLabel": [
    "Obsessive-compulsive disorder",
    "binge-eating disorder",
    "Hot flashes",
    "nerve pain",
    "ADHD",
    "PTSD",
    "migraine prevention",
    "Premenstrual dysphoric disorder"
  ],
  "status": "Rx",
  "pregnancyCategories": [
    "C"
  ]
}

As you know, medication products are known by many names. At minimum, there is a generic name. And usually at least one brand name. Sometimes the same generic drug is marketed under multiple brand names, for different purposes—for example, bupropion goes by the brand name Wellbutrin for treating depression and Zyban to help people quit smoking. In the Iodine API drugs are keyed to a canonical name. It is often, but not always the common name—a name that most Americans might be familiar with. Sometimes that’s a brand name—Xanax or Tylenol—but sometimes it’s the generic name—lithium or hydrochlorothiazide.

So, if your product knows about brand names, like the brand-name drug Effexor XR, write code to walk over every object in return. You’ll find that Effexor XR is one of the items in the array name.brand for the parent object effexor. That parent key is what you look up in the Iodine API. In other words, to get the data for Effexor XR you’d hit the following URL:

https://api.iodine.com/drug/effexor.json

More drug lookup examples

drug-name

A URL-escaped key for the medication. Use this to query the Iodine API. This is based on one of the names of the medication—the generic name, a brand name, or another more commonly known moniker.
name.common string

Common name. A familiar, widely known name for the medication.
name.generic string

Generic name. Usually the International Nonpropriatery Name. Generic names rarely include the chemical salt, but there are some examples, such as diclofenac sodium and diclofenac potassium. For drugs with multiple ingredients, they are usually separated by a slash /. Generic names are usually uppercase.
name.brand Array<string>

Brand names. One or more of the trade names that the medication is known by in the United States.
adderallAdderallDextroamphetamine/AmphetamineAdderall
Adderall XR
"adderall": {
  "name": {
    "generic": "Dextroamphetamine/Amphetamine",
    "brand": [
      "Adderall",
      "Adderall XR"
    ],
    "common": "Adderall"
  }
}
tylenolTylenolAcetaminophenTylenol
Tylenol Regular Strength
Tylenol Extra Strength
Tylenol 8 Hour
Anacin
Acephen
APAP
Paracetamol
"acetaminophen": {
  "name": {
    "generic": "Acetaminophen",
    "brand": [
      "Tylenol Regular Strength",
      "Tylenol Extra Strength",
      "Tylenol 8 Hour",
      "Anacin",
      "Acephen",
      "APAP",
      "Paracetamol"
    ],
    "common": "Tylenol"
  }
}
ibuprofenIbuprofenIbuprofenAdvil
Motrin IB
Nuprin
Motrin (Rx)
"ibuprofen": {
  "name": {
    "generic": "Ibuprofen",
    "brand": [
      "Advil",
      "Motrin IB",
      "Nuprin",
      "Motrin (Rx)"
    ],
    "common": "Ibuprofen"
  }
}
cambiaCambiaDiclofenac potassiumCambia
Zipsor
Cataflam
"cambia": {
  "name": {
    "generic": "Diclofenac potassium",
    "brand": [
      "Cataflam",
      "Cambia",
      "Zipsor"
    ],
    "common": "Cambia"
  }
}
influenza-vaccineFlu vaccineInfluenza vaccineFluMist
Afluria
Flublok
Fluzone
Fluzone High-Dose
Fluarix
FluLaval
Fluzone Quadrivalent
Fluvirin
Flucelvax
"influenza-vaccine": {
  "name": {
    "generic": "Influenza vaccine",
    "brand": [
      "FluMist",
      "Afluria",
      "Flublok",
      "Fluzone",
      "Fluzone High-Dose",
      "Fluarix",
      "FluLaval",
      "Fluzone Quadrivalent",
      "Fluvirin",
      "Flucelvax"
    ],
    "common": "Flu vaccine"
  }
}

Crediting and linking back to Iodine

You may choose to use just one piece of information from the Iodine API, or every piece. However, you need to clearly credit us as the source of the information. We’re flexible on how, but here are a few examples and guidelines.

Always show a general credit (that Iodine is the source of the information). It must be proximal to the information, not at the bottom of your about page.

Always show the drug name alongside any information about it. You must provide a link back to that drug’s page on Iodine. We suggest that you make the name of the drug the link, and we even have a special object in the API return to help you do that.

If you show review information and want to link to the reviews page on Iodine, use the special link object in the review section of the API return. It has the right URL.

MethodGuidelinesExamples
TextClearly indicate that Iodine is the source of the information. Provide a link back to Iodine (see our linking guidelines). Don’t say Iodine.com—we go by Iodine.Source: Iodine
Medication information by Iodine
Medication ratings from Iodine
ImageUse our logo, at a minimum height of 18 px. (With or without additional text.) Make the logo a link back to Iodine (see our linking guidelines). Don’t alter our logo in any ways. Contact us if you need a reverse logo or some other image.

Head and tail drugs

Our API has information on more than 1000 drugs, covering the vast majority of outpatient prescription and over-the-counter medications. However, we don’t have the same richness of information for every medication. The most common medications (which we call head drugs) have very rich information. The least common medications (which we call tail drugs) have much less information.

Our API always returns a dense object, with all fields present. If we don’t have data available for a given field, its value will be null. Compare Zoloft (a head drug) with oxsoralen (a tail drug) to see what we mean.

API return

For the rest of this reference, we’re using the API return for venlafaxine (brand names Effexor and Effexor XR). The return is divided into the following sections.

keySectionContent
nameMedication nameGeneric and brand names.
linkLinkUnique links back to Iodine.
basicsBasicsUser-friendly facts and descriptions of the medication.
pharmacistTipsPharmacist tipsTips for people taking the medication.
reviewsRatings (reviews)Real-world ratings of satisfaction, efficacy, and hassle.
whatToExpectWhat to expectCommon side effects and medication effect timeline.
categoryDrug categories (classes)Categories or classes of drug that this medication may belong to.
indicationsIndicationsOn and off-label indications (uses) of the medication.
alternativesAlternativesSimilar drugs (in the same class) or those used for similar purposes.
pregnancyCategoriesFDA pregnancy categoriesThe FDA pregnancy category (or categories) for the medication.
{
  "name": {},
  "link": {},
  "basics": {},
  "pharmacistTips": [],
  "reviews": {},
  "whatToExpect": {},
  "category": {},
  "indications": {},
  "alternatives": [],
  "pregnancyCategories": []
}

Medication name name object
Names that the medication is known by

"name": {
  "full": "Effexor (Venlafaxine)",
  "common": "Effexor",
  "generic": "Venlafaxine",
  "brand": [
    "Effexor",
    "Effexor XR"
  ]
}
keyNameTypeDescriptionExamples
fullFull namestringThe full name of the medication. This is usually the medication’s most common brand name, followed by its generic ingredient in parentheses. In some cases, when the medication is most commonly referred to by its generic ingredient (in search, or in practice) the brand name is ommitted. In general, this is the best name to use to refer to a medication.

Effexor (Venlafaxine)

Aleve (Naproxen)

Lithium

commonCommon namestringThe most commonly searched or used name for the medication. This is often the most well-known brand name of the medication, but not always. It may be another brand, or the generic name.

Effexor

Naproxen

Lithium

genericGeneric namestringThe generic name (ingredient) of the medication.

Venlafaxine

Naproxen

Lithium

brandBrand (trade) namesArray<string>Common brand (trade) names that the medication is marketed under.

Effexor

Effexor XR


Aleve

Naprosyn (Rx)

Anaprox (Rx)

Anaprox DS (Rx)


Lithobid

Lithane

Eskalith

Eskalith XR

Link link object
Unique links which you must use to give your users a way to get to this medication’s page on Iodine

"link": {
  "href": "https://www.iodine.com/drug/effexor?branchId=place-holder-id",
  "title": "Effexor",
  "html": "<a rel='nofollow' href='https://www.iodine.com/drug/effexor?branchId=place-holder-id'>Effexor</a>"
}
keyNameTypeDescriptionExamples
hrefLink referencestringThe unique URL that you should use when providing a link back to Iodine for this particular medication.
titleLink titlestringThe text that you should use when providing a link back to Iodine for this particular medication. This is usually the medication’s most common brand name, followed by its generic ingredient in parentheses (the "full name").

Effexor (Venlafaxine)

Aleve (Naproxen)

Lithium

htmlLink elementstringA ready-made <a> tag with the recommended link reference and link title to provide a link back to Iodine for this particular medication. Use this when you don’t need to customize the button or link tag in any way.

Basics basics object
Essential medication facts and descriptions

"basics": {
  "genericAvailable": true,
  "moa": "Venlafaxine is a serotonin and norepinephrine reuptake inhibitor (SNRI) antidepressant. It increases serotonin and norepinephrine activity in the brain, which regulate mood.",
  "oneLiner": "Improves mood and helps you relax.",
  "status": "Rx"
}
keyNameTypeDescriptionExamples
genericAvailableGeneric version availablebooleanWhether a generic version of the medication is available.
  • true The medication is available as a generic (usually less expensive).
  • false The medication is not available as a generic, only as a brand-name medication.
moaMechanism of actionstringA description of how the medication works. In this description, if the medication is named, it’s usually (but not always) referred to by its common name.Venlafaxine is a serotonin and norepinephrine reuptake inhibitor (SNRI) antidepressant. It increases serotonin and norepinephrine activity in the brain, which regulate mood.
one_linerOne-linerstringA pithy, (usually) one-line description of what the medication does. In this description, the medication is usually (but not always) referred to by its common name.Improves mood and helps you relax.
statusStatusstringWhether the medication is available over-the-counter, by prescription, or both.
  • Rx The medication is only available with a prescription.
  • OTC The medication is only available as an over-the-counter (non-prescription) product.
  • Rx, OTC
    Rx ,OTC
    OTC, Rx
    OTC ,Rx The medication is available in both in both an over-the-counter product, and by prescription.

Pharmacist tips pharmacistTips Array<string>
Tips for people taking the medication

"pharmacistTips": [
  "Takes about 8 to 12 weeks to see the medication's full effects on your mood.",
  "You can take the extended-release form once a day with food either in the morning or in the evening at about the same time each day.",
  "Extended-release capsules should be swallowed whole. If you can’t swallow pills, open the capsule, sprinkle it on a spoonful of applesauce and then swallow it without chewing.",
  "Stop taking it slowly to avoid getting withdrawal symptoms.",
  "Tell your doctor if you notice sudden mood changes or unusual thoughts."
]

A short list of (usually 3 to 7) pharmacist tips that are meant for people who are starting or taking the medication. These tips cover the most important counseling advice, including important dosing information or idiosyncratic warnings. This information is not comprehensive medication counseling and doesn’t replace consultation with a pharmacist or doctor.

keyNameTypeDescriptionExample
pharmacist tipstringA tip applicable for someone taking the medication.Stop taking it slowly to avoid getting withdrawal symptoms.

Ratings (reviews) reviews object
Ratings from real-world experience by medication-takers

Overall ratings and reviews (also known as real life experience, or RLE) for this medication. This is a dense object that provides granular rating data for many (but not all) medications broken down by age and sex dimensions. These dimensions are usually optional in our surveys, so the greatest number of reviews will be found in the objects for all ages and sexes. This information is not available for all medications.

"reviews": {
  "all": {
    "all": {
      "efficacy": {
        "efficacyLow": 17,
        "efficacyMid": 38,
        "efficacyHigh": 45,
        "mean": 4.74,
        "count": 141
      },
      "hassle": {
        "hassleHigh": 25,
        "hassleMid": 31,
        "hassleLow": 44,
        "mean": 3.48,
        "count": 141
      },
      "worth": {
        "worthIt": 60,
        "notSure": 13,
        "notWorthIt": 27,
        "count": 141
      }
    },
    "18-34": {},
    "35-54": {},
    "55AndOlder": {}
  },
  "female": {
    "all": {},
    "18-34": {},
    "35-54": {},
    "55AndOlder": {}
  },
  "male": {
    "all": {},
    "18-34": {},
    "35-54": {},
    "55AndOlder": {}
  },
  "count": 141,
  "link": {
    "href": "https://www.iodine.com/drug/effexor/reviews?branchId=place-holder-id",
    "title": "Effexor",
    "html": "<a rel='nofollow' href='https://www.iodine.com/drug/effexor/reviews?branchId=place-holder-id'>Effexor</a>"
  }
}

Overall structure

Reviews are a multidimensional object. First, they are broken into buckets by sex, and then by age. Within each sex > age bucket (e.g. reviews['all']['18-34']) there are discrete efficacy, hassle, and worth sections with the actual ratings data.

keyNameTypeDescriptionExample
Sex bucketobjectSex buckets. These are found at the top level of the reviews object.
  • all Both sexes combined.
  • female Females.
  • male Males.
Age bucketobjectAge buckets. These are nested below each [ageBucket] object.
  • all All ages combined.
  • 18-34 Ages 18 to 34.
  • 35-54 Ages 35 to 54.
  • 55AndOlder Ages 55 and older.
countNumber of ratingsintegerThe maximum number of ratings, combining all sex and age buckets, and based on whichever dimension (efficacy, hassle, or worth) has the most ratings.
linkReviews link to IodineobjectLinks back to Iodine for this medication’s reviews. Use this if you want to provide a unique link for medication reviews—it’ll link directly to the ratings and reviews section for this medication on Iodine.

This follows the structure of the link section, but you should use more contxt-sensitive text like Read more reviews of Lipitor (Atorvastatin) on Iodine.

Perceived effectiveness efficacy object
How well the medication worked for the reviewer (its perceived efficacy or effectiveness)

This is a subjective measure, asked with a variation of the phrase "Did it work for you?" and a Likert-type response 7-point scale. The low value (1) is labeled "didn’t work well," the middle value (4) is labeled "worked so-so", and the high value (7) is labeled "worked well."

keyNameTypeDescriptionExample
efficacyLowProportion saying low efficacyintegerProportion of reviewers who reported low perceived efficacy (1 or 2 a.k.a. "didn’t work well") on the 7-point scale.
efficacyMidProportion saying moderate efficacyintegerProportion of reviewers who reported moderate perceived efficacy (3, 4, or 5 a.k.a. "worked so-so") on the 7-point scale.
efficacyHighProportion saying high efficacyintegerProportion of reviewers who reported high perceived efficacy (6 or 7 a.k.a. "worked well") on the 7-point scale.
meanMean efficacynumberThe mean perceived efficacy on the 7-point scale.
countNumber of efficacy ratingsintegerThe number of perceived efficacy ratings.

Perceived hassle hassle object
How much of a hassle the reviewer felt the medication was (its perceived hassle)

This is a subjective measure of the interference caused by the medication with everyday life—including dosing, lifestyle changes and side effects—asked with a variation of the phrase "Was it a hassle (including side effects and interference with everyday life)?" and a Likert-type response 7-point scale. The low value (1) is labeled "no hassle" the middle value (4) is labeled "some hassle", and the high value (7) is labeled "huge hassle."

keyNameTypeDescriptionExample
hassleHighProportion saying high hassleintegerProportion of reviewers who reported high perceived hassle (6 or 7 a.k.a. "huge hassle") on the 7-point scale.
hassleMidProportion saying moderate hassleintegerProportion of reviewers who reported moderate perceived hassle (3, 4, or 5 a.k.a. "some hassle") on the 7-point scale.
hassleLowProportion saying low hassleintegerProportion of reviewers who reported low perceived hassle (1 or 2 a.k.a. "no hassle") on the 7-point scale.
meanMean hasslenumberThe mean perceived hassle on the 7-point scale.
countNumber of hassle ratingsintegerThe number of perceived hassle ratings.

Overall satisfaction worth object
Global satisfaction with the medication, on balance

Whether the reviewer felt the medication was worth it overall, not worth it, or they weren’t sure or don’t know. This is a subjective measure of global satisfaction with the medication, asked with a variation of the phrase "Was it worth it overall?" and the 3 discrete responses.

keyNameTypeDescriptionExample
worthItProportion saying worth itintegerProportion of reviewers who reported that the medication was worth it overall.
notSureProportion saying not sure or don’t knowintegerProportion of reviewers who reported that they didn’t know or were unsure about whether the medication was worth it overall.
notWorthItProportion saying not worth itintegerProportion of reviewers who reported that the medication wasn’t worth it overall.
countNumber of worth ratingsintegerThe number of overall satisfaction ratings.

What to expect whatToExpect Array<Object>
Timelines of medication and side effects

An hours-to-months timeline of medication effect (usually therapeutic effect) and the most common side effects. It shows users when to expect certain effects to occur, and how long they typically last. This information is not available for all medications.

"whatToExpect": [
  {
    "indication": "Depression",
    "effects": [
      {
        "name": "Starts to kick in",
        "range": [
          2,
          2
        ]
      },
      {
        "name": "Full effects",
        "range": [
          3,
          3
        ]
      }
    ],
    "sideEffects": [
      {
        "name": "Stomach problems",
        "range": [
          1,
          2
        ],
        "lessCommon": false
      },
      {
        "name": "Sleep problems",
        "range": [
          1,
          4
        ],
        "lessCommon": false
      },
      {
        "name": "Drowsiness",
        "range": [
          1,
          2
        ],
        "lessCommon": false
      },
      {
        "name": "Dizziness",
        "range": [
          1,
          2
        ],
        "lessCommon": false
      },
      {
        "name": "Sweating",
        "range": [
          1,
          2
        ],
        "lessCommon": false
      },
      {
        "name": "Lower sex drive",
        "range": [
          2,
          4
        ],
        "lessCommon": false
      }
    ]
  }
]

Timeline

There is one timeline for each of the most common indications for use, or if there are no differences between the timelines for each indication, then there is a single timeline applicable to all on-label indications.

keyNameTypeDescriptionExamples
indicationIndicationstringThe indication (use) for which this timeline applies. Many medications have multiple uses, and both therapeutic and side effects may vary between indications.

Depression

PTSD

All indications

Any indication

effectsMedication effectsArray<Object>This array contains two medication effect objects. These describe roughly when the medication starts to take effect (therapeutic effect), and when the full effects can be expected or felt.
sideEffectsSide effectsArray<Object>This array contains one or more side effect objects. These are usually the most common side effects, and describe roughly when the side effect is typically felt, and how long the side effect tends to last.

Medication effect

There are two medication effect objects, one for describing when the therapeutic effect starts to kick in, and another for when the full effect is generally expected.

keyNameTypeDescriptionExamples
nameStage of effectstringWhich of the two stages of medication effect this object describes: the initial effects, or full effects.
  • Starts to kick in This object represents the rough timeframe at which the medication starts to kick in.
  • Full effects This object represents the rough timeframe within which the medication’s full effects are generally experienced.
rangeMedication effect rangeArray<number>When this stage of medication effect starts and (optionally) ends. The first integer in the array represents the start time range, and the second integer represents the end time range.

For Full effects the second integer is present but has no meaning; it’s expected that medication effects continue indefinitely (into the long-term time range. If the values are 0, it means that full effects are generally seen within the first few hours (the same timeframe as when the medication starts to kick in). In this case, we usually render the Starts to kick in effect in the first few hours area, and the Full effects effect in the first few days area so that there appears to be a sequence.

  • 0 First few hours.
  • 1 First few days.
  • 2 First few weeks.
  • 3 First few months.
  • 4 Long-term.

Side effect

There are one or more side effect objects.

keyNameTypeDescriptionExamples
nameSide effect namestringThe side effect name.
  • Starts to kick in This object represents the rough timeframe at which the medication starts to kick in.
  • Full effects This object represents the rough timeframe within which the medication’s full effects are generally experienced.

Headache

Sleep problems

Drowsiness

rangeMedication effect time rangeArray<number>When this side effect tends to occur and go away. The first integer in the array represents the start time range, and the second integer represents the end time range.
  • 0 First few hours.
  • 1 First few days.
  • 2 First few weeks.
  • 3 First few months.
  • 4 Long-term.
lessCommonLess common side effectbooleanWhether this is a less frequent but still important side effect. In general, the side effect list only includes a handful of the most common side effects to watch out for. If one is identified as less common, it should be clearly identified as such.
  • true This is a less common side effect.
  • false This is a common side effect.

Category (class) category object
What kind of drug this medication is. These are user-friendly descriptions which draw on established classification systems.

"category": {
  "name": "Mental health",
  "subcategories": [
    {
      "name": "Antidepressant",
      "subcategories": [
        {
          "name": "Serotonin-norepinephrine reuptake inhibitor (SNRI)"
        }
      ]
    }
  ]
}

The category or subcategories that the medication belongs to. This is a recursive object; it may itself contain an array of subcategory objects that follow the same structure. Each medication has a primary category, but may not have subcategories.

keyNameTypeDescriptionExamples
name
Category or class namestringCategory or class name. These are (for the most common drugs) plain-language descriptions which draw on established classification systems, but do not follow those systems precisely.

Category

Mental health

Pain

Cardiovascular


Subcategory 1

Antidepressant

Pain reliever

Antihistamine


Subcategory 2

Serotonin-norepinephrine reuptake inhibitor (SNRI)

NSAID

1st generation

subcategories
SubcategoriesArray<Object>Optional. Subcategories that the medication belongs to. This object follows the same structure as its parent (having a name and optional subcategories array).

Indications indications object
On and off-label medication uses (diseases, diagnoses, symptoms, syndromes, or other reasons for use)

"indications": {
  "onLabel": [
    "Depression",
    "Anxiety",
    "Social anxiety",
    "Panic disorder"
  ],
  "offLabel": [
    "Obsessive-compulsive disorder",
    "binge-eating disorder",
    "Hot flashes",
    "nerve pain",
    "ADHD",
    "PTSD",
    "migraine prevention",
    "Premenstrual dysphoric disorder"
  ]
}
keyNameTypeDescriptionExamples
onLabelOn-label indicationsArray<string> (Indication)The on-label (approved and documented in the FDA package insert) indications for use. These are generally user-friendly terms (e.g. depression) instead of clinical terms (e.g. MDD, or major depressive disorder), but not always.
offLabelOff-label indicationsArray<string> (Indication)Off-label (doctor’s discretion) indications for use. These are sometimes user-friendly terms, and sometimes acronyms or clinical terms.

Alternatives alternatives Array<Object>
Medications used for similar purposes

If we have alternatives for a medication, the alternatives array will contain at least one object. If not, this field’s value will be null.

"alternatives": [
  {
    "link": {
      "href": "https://www.iodine.com/drug/cymbalta?branchId=place-holder-id",
      "title": "Cymbalta",
      "html": "<a rel='nofollow' href='https://www.iodine.com/drug/cymbalta?branchId=place-holder-id'>Cymbalta</a>"
    },
    "name": {
      "full": "Cymbalta (Duloxetine)",
      "common": "Cymbalta",
      "generic": "Duloxetine",
      "brand": [
        "Cymbalta"
      ]
    }
  },
  {
    "link": {
      "href": "https://www.iodine.com/drug/celexa?branchId=place-holder-id",
      "title": "Celexa",
      "html": "<a rel='nofollow' href='https://www.iodine.com/drug/celexa?branchId=place-holder-id'>Celexa</a>"
    },
    "name": {
      "full": "Celexa (Citalopram)",
      "common": "Citalopram",
      "generic": "Citalopram",
      "brand": [
        "Celexa"
      ]
    }
  }
]

Each alternative object has two sections.

keyNameTypeDescriptionExamples
linkAlternative link to IodineobjectIf there is an Iodine page for this alternative, this field will contain an object with special links back to Iodine. Use it if you want to provide a link to this alternative’s medication page on Iodine.

This follows the structure of the link section.

nameAlternative namesobject

The alternative medication’s names. If the alternative has a page on Iodine, this object will have a fill name, brand name, generic name, and so on. If not, there will be a full name but there may not be a generic name, common name, or array of brand names.

This follows the structure of the name section.

Pregnancy categories pregnancyCategories Array<string>
Whether the medication is safe to take before or during pregnancy, or while nursing

"pregnancyCategories": [
  "C"
]
keyNameTypeDescriptionExamples
Pregnancy categorystringThe FDA pregnancy categories in which the medication has been classified. The vast majority of drugs only have one such category.
  • A Safe. Research studies with real people haven’t found any risk to unborn babies in the first trimester. There’s no evidence of risk later in pregnancy, either.
  • B Probably safe. Research studies with animals haven’t found a risk to unborn babies, but it hasn’t been properly studied in humans.
  • C Weigh risks vs. benefits. Research studies with animals found harmful effects on unborn babies. It hasn’t been properly studied in humans. The benefits might outweigh the risks even if you’re pregnant. Talk with your doctor.
  • D Weigh risks vs. benefits. Research studies with real people found harmful effects on unborn babies, but the benefits might outweigh the risks even if you’re pregnant. Talk with your doctor.
  • X Unknown. Research studies with real people or animals found harmful effects on unborn babies. If you’re pregnant, the risks to your unborn baby outweigh the benefits.
  • N Unsafe. The FDA hasn’t classified this medicine’s effects on unborn babies. Talk with your doctor about this medicine if you’re pregnant or planning on it.

Complete API result example for Effexor (venlafaxine)

"effexor": {
  "name": {
    "full": "Effexor (Venlafaxine)",
    "common": "Effexor",
    "generic": "Venlafaxine",
    "brand": [
      "Effexor",
      "Effexor XR"
    ]
  },
  "link": {
    "href": "https://www.iodine.com/drug/effexor?branchId=place-holder-id",
    "title": "Effexor",
    "html": "<a rel='nofollow' href='https://www.iodine.com/drug/effexor?branchId=place-holder-id'>Effexor</a>"
  },
  "basics": {
    "genericAvailable": true,
    "moa": "Venlafaxine is a serotonin and norepinephrine reuptake inhibitor (SNRI) antidepressant. It increases serotonin and norepinephrine activity in the brain, which regulate mood.",
    "oneLiner": "Improves mood and helps you relax.",
    "status": "Rx"
  },
  "pharmacistTips": [
    "Takes about 8 to 12 weeks to see the medication's full effects on your mood.",
    "You can take the extended-release form once a day with food either in the morning or in the evening at about the same time each day.",
    "Extended-release capsules should be swallowed whole. If you can’t swallow pills, open the capsule, sprinkle it on a spoonful of applesauce and then swallow it without chewing.",
    "Stop taking it slowly to avoid getting withdrawal symptoms.",
    "Tell your doctor if you notice sudden mood changes or unusual thoughts."
  ],
  "reviews": {
    "all": {
      "all": {
        "efficacy": {
          "efficacyLow": 17,
          "efficacyMid": 38,
          "efficacyHigh": 45,
          "mean": 4.74,
          "count": 141
        },
        "hassle": {
          "hassleHigh": 25,
          "hassleMid": 31,
          "hassleLow": 44,
          "mean": 3.48,
          "count": 141
        },
        "worth": {
          "worthIt": 60,
          "notSure": 13,
          "notWorthIt": 27,
          "count": 141
        }
      },
      "18-34": {
        "efficacy": {
          "efficacyLow": 21,
          "efficacyMid": 50,
          "efficacyHigh": 29,
          "mean": 4.25,
          "count": 24
        },
        "hassle": {
          "hassleHigh": 25,
          "hassleMid": 42,
          "hassleLow": 33,
          "mean": 3.75,
          "count": 24
        },
        "worth": {
          "worthIt": 58,
          "notSure": 13,
          "notWorthIt": 29,
          "count": 24
        }
      },
      "35-54": {
        "efficacy": {
          "efficacyLow": 16,
          "efficacyMid": 29,
          "efficacyHigh": 55,
          "mean": 4.87,
          "count": 31
        },
        "hassle": {
          "hassleHigh": 39,
          "hassleMid": 23,
          "hassleLow": 39,
          "mean": 4.03,
          "count": 31
        },
        "worth": {
          "worthIt": 61,
          "notSure": 10,
          "notWorthIt": 29,
          "count": 31
        }
      },
      "55AndOlder": {
        "efficacy": {
          "efficacyLow": 10,
          "efficacyMid": 35,
          "efficacyHigh": 55,
          "mean": 5.2,
          "count": 40
        },
        "hassle": {
          "hassleHigh": 20,
          "hassleMid": 33,
          "hassleLow": 48,
          "mean": 3.23,
          "count": 40
        },
        "worth": {
          "worthIt": 65,
          "notSure": 10,
          "notWorthIt": 25,
          "count": 40
        }
      }
    },
    "female": {
      "18-34": {
        "efficacy": {
          "efficacyLow": 14,
          "efficacyMid": 57,
          "efficacyHigh": 29,
          "mean": 4.43,
          "count": 14
        },
        "hassle": {
          "hassleHigh": 29,
          "hassleMid": 43,
          "hassleLow": 29,
          "mean": 3.86,
          "count": 14
        },
        "worth": {
          "worthIt": 64,
          "notSure": 7,
          "notWorthIt": 29,
          "count": 14
        }
      },
      "all": {
        "efficacy": {
          "efficacyLow": 7,
          "efficacyMid": 44,
          "efficacyHigh": 48,
          "mean": 5.11,
          "count": 54
        },
        "hassle": {
          "hassleHigh": 20,
          "hassleMid": 33,
          "hassleLow": 46,
          "mean": 3.26,
          "count": 54
        },
        "worth": {
          "worthIt": 69,
          "notSure": 7,
          "notWorthIt": 24,
          "count": 54
        }
      },
      "35-54": {
        "efficacy": {
          "efficacyLow": 8,
          "efficacyMid": 38,
          "efficacyHigh": 54,
          "mean": 5.23,
          "count": 13
        },
        "hassle": {
          "hassleHigh": 15,
          "hassleMid": 23,
          "hassleLow": 62,
          "mean": 2.77,
          "count": 13
        },
        "worth": {
          "worthIt": 77,
          "notSure": 0,
          "notWorthIt": 23,
          "count": 13
        }
      },
      "55AndOlder": {
        "efficacy": {
          "efficacyLow": 4,
          "efficacyMid": 42,
          "efficacyHigh": 54,
          "mean": 5.38,
          "count": 26
        },
        "hassle": {
          "hassleHigh": 19,
          "hassleMid": 35,
          "hassleLow": 46,
          "mean": 3.27,
          "count": 26
        },
        "worth": {
          "worthIt": 65,
          "notSure": 12,
          "notWorthIt": 23,
          "count": 26
        }
      }
    },
    "male": {
      "18-34": {
        "efficacy": {
          "efficacyLow": 30,
          "efficacyMid": 40,
          "efficacyHigh": 30,
          "mean": 4,
          "count": 10
        },
        "hassle": {
          "hassleHigh": 20,
          "hassleMid": 40,
          "hassleLow": 40,
          "mean": 3.6,
          "count": 10
        },
        "worth": {
          "worthIt": 50,
          "notSure": 20,
          "notWorthIt": 30,
          "count": 10
        }
      },
      "all": {
        "efficacy": {
          "efficacyLow": 24,
          "efficacyMid": 28,
          "efficacyHigh": 48,
          "mean": 4.54,
          "count": 46
        },
        "hassle": {
          "hassleHigh": 37,
          "hassleMid": 28,
          "hassleLow": 35,
          "mean": 4.09,
          "count": 46
        },
        "worth": {
          "worthIt": 50,
          "notSure": 17,
          "notWorthIt": 33,
          "count": 46
        }
      },
      "35-54": {
        "efficacy": {
          "efficacyLow": 22,
          "efficacyMid": 22,
          "efficacyHigh": 56,
          "mean": 4.61,
          "count": 18
        },
        "hassle": {
          "hassleHigh": 56,
          "hassleMid": 22,
          "hassleLow": 22,
          "mean": 4.94,
          "count": 18
        },
        "worth": {
          "worthIt": 50,
          "notSure": 17,
          "notWorthIt": 33,
          "count": 18
        }
      },
      "55AndOlder": {
        "efficacy": {
          "efficacyLow": 21,
          "efficacyMid": 21,
          "efficacyHigh": 57,
          "mean": 4.86,
          "count": 14
        },
        "hassle": {
          "hassleHigh": 21,
          "hassleMid": 29,
          "hassleLow": 50,
          "mean": 3.14,
          "count": 14
        },
        "worth": {
          "worthIt": 64,
          "notSure": 7,
          "notWorthIt": 29,
          "count": 14
        }
      }
    },
    "count": 141,
    "link": {
      "href": "https://www.iodine.com/drug/effexor/reviews?branchId=place-holder-id",
      "title": "Effexor",
      "html": "<a rel='nofollow' href='https://www.iodine.com/drug/effexor/reviews?branchId=place-holder-id'>Effexor</a>"
    }
  },
  "whatToExpect": [
    {
      "indication": "Depression",
      "effects": [
        {
          "name": "Starts to kick in",
          "range": [
            2,
            2
          ]
        },
        {
          "name": "Full effects",
          "range": [
            3,
            3
          ]
        }
      ],
      "sideEffects": [
        {
          "name": "Stomach problems",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Sleep problems",
          "range": [
            1,
            4
          ],
          "lessCommon": false
        },
        {
          "name": "Drowsiness",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Dizziness",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Sweating",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Lower sex drive",
          "range": [
            2,
            4
          ],
          "lessCommon": false
        }
      ]
    },
    {
      "indication": "Panic disorder",
      "effects": [
        {
          "name": "Starts to kick in",
          "range": [
            2,
            2
          ]
        },
        {
          "name": "Full effects",
          "range": [
            3,
            3
          ]
        }
      ],
      "sideEffects": [
        {
          "name": "Stomach problems",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Sleep problems",
          "range": [
            1,
            4
          ],
          "lessCommon": false
        },
        {
          "name": "Drowsiness",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Dizziness",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Sweating",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Lower sex drive",
          "range": [
            2,
            4
          ],
          "lessCommon": false
        }
      ]
    },
    {
      "indication": "Social anxiety disorder",
      "effects": [
        {
          "name": "Starts to kick in",
          "range": [
            2,
            2
          ]
        },
        {
          "name": "Full effects",
          "range": [
            3,
            3
          ]
        }
      ],
      "sideEffects": [
        {
          "name": "Stomach problems",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Sleep problems",
          "range": [
            1,
            4
          ],
          "lessCommon": false
        },
        {
          "name": "Drowsiness",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Dry mouth",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Weakness",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Lower sex drive",
          "range": [
            2,
            4
          ],
          "lessCommon": false
        }
      ]
    },
    {
      "indication": "Anxiety",
      "effects": [
        {
          "name": "Starts to kick in",
          "range": [
            2,
            2
          ]
        },
        {
          "name": "Full effects",
          "range": [
            3,
            3
          ]
        }
      ],
      "sideEffects": [
        {
          "name": "Stomach problems",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Sleep problems",
          "range": [
            1,
            4
          ],
          "lessCommon": false
        },
        {
          "name": "Drowsiness",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Dry mouth",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Weakness",
          "range": [
            1,
            2
          ],
          "lessCommon": false
        },
        {
          "name": "Lower sex drive",
          "range": [
            2,
            4
          ],
          "lessCommon": false
        }
      ]
    }
  ],
  "category": {
    "name": "Mental health",
    "subcategories": [
      {
        "name": "Antidepressant",
        "subcategories": [
          {
            "name": "Serotonin-norepinephrine reuptake inhibitor (SNRI)"
          }
        ]
      }
    ]
  },
  "indications": {
    "onLabel": [
      "Depression",
      "Anxiety",
      "Social anxiety",
      "Panic disorder"
    ],
    "offLabel": [
      "Obsessive-compulsive disorder",
      "binge-eating disorder",
      "Hot flashes",
      "nerve pain",
      "ADHD",
      "PTSD",
      "migraine prevention",
      "Premenstrual dysphoric disorder"
    ]
  },
  "alternatives": [
    {
      "link": {
        "href": "https://www.iodine.com/drug/cymbalta?branchId=place-holder-id",
        "title": "Cymbalta",
        "html": "<a rel='nofollow' href='https://www.iodine.com/drug/cymbalta?branchId=place-holder-id'>Cymbalta</a>"
      },
      "name": {
        "full": "Cymbalta (Duloxetine)",
        "common": "Cymbalta",
        "generic": "Duloxetine",
        "brand": [
          "Cymbalta"
        ]
      }
    },
    {
      "link": {
        "href": "https://www.iodine.com/drug/celexa?branchId=place-holder-id",
        "title": "Celexa",
        "html": "<a rel='nofollow' href='https://www.iodine.com/drug/celexa?branchId=place-holder-id'>Celexa</a>"
      },
      "name": {
        "full": "Celexa (Citalopram)",
        "common": "Citalopram",
        "generic": "Citalopram",
        "brand": [
          "Celexa"
        ]
      }
    },
    {
      "link": {
        "href": "https://www.iodine.com/drug/lexapro?branchId=place-holder-id",
        "title": "Lexapro",
        "html": "<a rel='nofollow' href='https://www.iodine.com/drug/lexapro?branchId=place-holder-id'>Lexapro</a>"
      },
      "name": {
        "full": "Lexapro (Escitalopram)",
        "common": "Lexapro",
        "generic": "Escitalopram",
        "brand": [
          "Lexapro"
        ]
      }
    },
    {
      "link": {
        "href": "https://www.iodine.com/drug/prozac?branchId=place-holder-id",
        "title": "Prozac",
        "html": "<a rel='nofollow' href='https://www.iodine.com/drug/prozac?branchId=place-holder-id'>Prozac</a>"
      },
      "name": {
        "full": "Prozac (Fluoxetine)",
        "common": "Prozac",
        "generic": "Fluoxetine",
        "brand": [
          "Prozac",
          "Prozac Weekly",
          "Sarafem"
        ]
      }
    },
    {
      "link": {
        "href": "https://www.iodine.com/drug/paxil?branchId=place-holder-id",
        "title": "Paxil",
        "html": "<a rel='nofollow' href='https://www.iodine.com/drug/paxil?branchId=place-holder-id'>Paxil</a>"
      },
      "name": {
        "full": "Paxil (Paroxetine)",
        "common": "Paxil",
        "generic": "Paroxetine",
        "brand": [
          "Paxil",
          "Paxil CR",
          "Pexeva",
          "Brisdelle"
        ]
      }
    },
    {
      "link": {
        "href": "https://www.iodine.com/drug/wellbutrin?branchId=place-holder-id",
        "title": "Wellbutrin",
        "html": "<a rel='nofollow' href='https://www.iodine.com/drug/wellbutrin?branchId=place-holder-id'>Wellbutrin</a>"
      },
      "name": {
        "full": "Zyban (Bupropion)",
        "common": "Zyban",
        "generic": "Bupropion",
        "brand": [
          "Zyban",
          "Buproban",
          "Budeprion",
          "Wellbutrin"
        ]
      }
    },
    {
      "link": {
        "href": "https://www.iodine.com/drug/remeron?branchId=place-holder-id",
        "title": "Remeron",
        "html": "<a rel='nofollow' href='https://www.iodine.com/drug/remeron?branchId=place-holder-id'>Remeron</a>"
      },
      "name": {
        "full": "Remeron (Mirtazapine)",
        "common": "Mirtazapine",
        "generic": "Mirtazapine",
        "brand": [
          "Remeron"
        ]
      }
    },
    {
      "link": {
        "href": "https://www.iodine.com/drug/oleptro?branchId=place-holder-id",
        "title": "Oleptro",
        "html": "<a rel='nofollow' href='https://www.iodine.com/drug/oleptro?branchId=place-holder-id'>Oleptro</a>"
      },
      "name": {
        "full": "Oleptro (Trazodone)",
        "common": "Trazodone",
        "generic": "Trazodone",
        "brand": [
          "Oleptro",
          "Desyrel"
        ]
      }
    }
  ],
  "pregnancyCategories": [
    "C"
  ]
}