API Reference

Our API provides programmatic access to drug information, conditions, and nutrient data. Use the endpoints below to integrate with the Antidote Research API.

Authentication

All API requests are currently public access. Rate limiting may apply to prevent abuse.

Base URL

https://api.needantidote.com/v1/partner

Common Parameters

ParameterTypeDescription
limitIntegerMaximum number of records to return (default: 100, max: 500)
skipIntegerNumber of records to skip (for pagination)

Endpoints

Conditions

GET/conditions

Returns a list of medical conditions.

Query Parameters:

  • limit (optional) - Maximum number of records to return (default: 100, max: 500)
  • skip (optional) - Number of records to skip for pagination (default: 0)

Example Request:

GET https://api.needantidote.com/v1/partner/conditions?limit=10

Example Response:

{
  "data": [
    {
      "id": "antacids",
      "name": "Stomach Acid",
      "description": "Antacids can help relieve mild, occasional heartburn and indigestion by neutralizing stomach acid. They can also help with other conditions, such as acid reflux, gastritis, stomach ulcers, and gastroesophageal reflux disease (GERD)."
    },
    {
      "id": "cholesterol",
      "name": "High Cholesterol",
      "description": "High cholesterol is a medical condition characterized by elevated levels of cholesterol in the blood, which can increase the risk of heart disease and stroke."
    },
    ...
  ],
  "pagination": {
    "limit": 10,
    "skip": 0,
    "hasMore": true
  }
}
GET/conditions/:id

Returns details for a specific condition.

Path Parameters:

  • id - The unique identifier of the condition

Example Request:

GET https://api.needantidote.com/v1/partner/conditions/diabetes

Example Response:

{
  "data": {
    "id": "diabetes",
    "name": "Diabetes",
    "description": "Diabetes is a chronic medical condition characterized by the body's inability to properly regulate blood sugar levels, either due to insufficient insulin production (Type 1) or insulin resistance (Type 2)."
  }
}

Drugs

Note: The conditionId and conditionName fields in drug responses can be either a string or null if a drug is not associated with a specific condition in our database.

GET/drugs/list

Returns a list of drugs with pagination.

Query Parameters:

  • limit (optional) - Maximum number of records to return (default: 100, max: 500)
  • skip (optional) - Number of records to skip for pagination (default: 0)

Example Request:

GET https://api.needantidote.com/v1/partner/drugs/list?limit=20&skip=20

Example Response:

{
  "data": [
    {
      "id": "aerospan",
      "name": "Aerospan",
      "sideEffects": "Side effects of the inflammation drug Aerospan may include:<br />1. Irritation or dryness of the throat or mouth<br />2. Hoarseness or voice changes<br />3. Cough<br />4. Headache<br />5. Upset stomach<br />6. Nasal congestion or sinus pain<br />7. Vomiting<br />8. Muscle or joint pain<br />9. Dizziness<br />10. Increased appetite or weight gain<br /><br />It is important to consult with a healthcare provider if any of these side effects are experienced, especially if they persist or worsen over time.",
      "conditionName": "Inflammation",
      "conditionId": "inflammation",
      "summary": "Aerospan is a brand name for the prescription medication flunisolide, which is a corticosteroid that is used to help reduce inflammation in the airways and improve breathing in patients with asthma. It is typically administered through an inhaler."
    },
    {
      "id": "afeditab_cr",
      "name": "Afeditab CR",
      "sideEffects": "Afeditab CR, a medication used to treat hypertension, may cause side effects such as dizziness, flushing, headache, and swelling of the lower extremities. Less common but more serious side effects include severe hypotension, heart palpitations, and allergic reactions. Patients should report any unusual or severe symptoms to their healthcare provider promptly.",
      "conditionName": "Hypertension",
      "conditionId": "hypertension",
      "summary": "AFEDITAB CR is a prescription medication containing nifedipine, a calcium channel blocker used to treat high blood pressure (hypertension) and certain types of chest pain (angina). It works by relaxing blood vessels, allowing blood to flow more easily and reducing the heart's workload. The \"CR\" stands for controlled release, meaning the drug is designed to be released slowly over time for prolonged effect."
    },
    {
      "id": "some_generic_drug",
      "name": "Some Generic Drug",
      "sideEffects": "Potential side effects include...",
      "conditionName": null,
      "conditionId": null,
      "summary": "This drug is used for various purposes and may not be tied to a single condition."
    },
    ...
  ],
  "pagination": {
    "limit": 20,
    "skip": 20,
    "hasMore": true
  }
}
GET/drug/:id

Returns detailed information for a specific drug.

Path Parameters:

  • id - The unique identifier of the drug

Example Request:

GET https://api.needantidote.com/v1/partner/drug/aspirin

Example Response:

{
  "data": {
    "id": "aspirin",
    "name": "Aspirin",
    "conditionName": "Pain Management",
    "conditionId": "analgesics",
    "summary": "Aspirin is a common over-the-counter medication used to treat pain, reduce inflammation, and lower fever. It belongs to a group of medications known as nonsteroidal anti-inflammatory drugs (NSAIDs). Aspirin works by inhibiting an enzyme...",
    "sideEffects": "Some potential side effects of aspirin include:<br /><br />- Upset stomach or stomach pain<br />- Heartburn<br />...",
    "nutrientDepletions": [
      {
        "id": "aspirin_folic_acid",
        "name": "Folic Acid",
        "reasons": "Regular aspirin use, even at therapeutic doses, can lead to lower-than-normal levels of folate in the blood...",
        "class": "Salicylates",
        "category": "Analgesics",
        "dose": "0.34 DFE",
        "replacement": "Folate (.2mg as L-5-Methylfolate)",
        "evidence": ""
      },
      ...
    ],
    "supportingNutrients": [
      {
        "id": "aspirin_vitamin_b12",
        "name": "Vitamin B12",
        "reasons": "Research found that individuals hospitalized with heart disease and a history of aspirin use were nearly twice as likely to have low or borderline vitamin B12 levels...",
        "class": "Salicylates",
        "category": "Analgesics",
        "dose": "0.2 mg",
        "replacement": "Vitamin B12 Methylcobalamin",
        "evidence": "van Oijen MG, Laheij RJ, Peters WH, Jansen JB, Verheugt FW; BACH study. Association of aspirin use with vitamin B12 deficiency..."
      },
      ...
    ],
    "beneficialNutrients": [
      {
        "evidence": "Kuszewski JC, Wong RHX, Howe PRC. Fish oil supplementation reduces osteoarthritis-specific pain in older adults...",
        "name": "Omega 3",
        "reasons": "Omega-3 fatty acids offer promise for managing pain associated with osteoarthritis (OA)...",
        "conditionId": "analgesics"
      },
      ...
    ]
  }
}

// Example response for a drug with null condition:
{
  "data": {
    "id": "another_drug",
    "name": "Another Drug",
    "conditionName": null,
    "conditionId": null,
    "summary": "Details about this other drug...",
    "sideEffects": "Side effects information...",
    "nutrientDepletions": [],
    "supportingNutrients": [],
    "beneficialNutrients": []
  }
}
GET/drugs/condition/:conditionId

Returns drugs associated with a specific condition.

Path Parameters:

  • conditionId - The unique identifier of the condition

Query Parameters:

  • limit (optional) - Maximum number of records to return (default: 100, max: 500)
  • skip (optional) - Number of records to skip for pagination (default: 0)

Example Request:

GET https://api.needantidote.com/v1/partner/drugs/condition/diabetes?limit=3

Example Response:

{
  "data": [
    {
      "id": "acetohexamide",
      "name": "Acetohexamide",
      "sideEffects": "Some common side effects of acetohexamide include...",
      "conditionName": "Diabetes",
      "conditionId": "diabetes",
      "summary": "Acetohexamide is an oral medication used to treat type 2 diabetes..."
    },
    {
      "id": "actoplus_met",
      "name": "Actoplus Met",
      "sideEffects": "Common side effects of Actoplus Met (metformin and pioglitazone) may include...",
      "conditionName": "Diabetes",
      "conditionId": "diabetes",
      "summary": "Actoplus Met is a combination medication that contains two active ingredients..."
    },
    ...
  ],
  "pagination": {
    "limit": 3,
    "skip": 0,
    "hasMore": true
  }
}
GET/drugs/search/:query

Searches drugs by name and returns matching results.

Path Parameters:

  • query - Search term to find matching drugs

Query Parameters:

  • limit (optional) - Maximum number of records to return (default: 50)

Example Request:

GET https://api.needantidote.com/v1/partner/drugs/search/advl

Example Response:

{
  "data": [
    {
      "id": "advil",
      "name": "Advil",
      "sideEffects": "Some common side effects of Analgesics drug Advil (ibuprofen) include...",
      "conditionName": "Analgesics",
      "conditionId": "analgesics",
      "summary": "Advil is the brand name for ibuprofen, a nonsteroidal anti-inflammatory drug..."
    },
    {
      "id": "advil_pm",
      "name": "Advil PM",
      "sideEffects": "Some common side effects of Advil PM...",
      "conditionName": "Analgesics",
      "conditionId": "analgesics",
      "summary": "Advil PM is a brand name over-the-counter medication that combines..."
    },
    ...
  ],
  "pagination": {
    "limit": 50,
    "skip": 0,
    "hasMore": false
  }
}

Nutrients

GET/nutrient/depletion/:id

Returns details for a drug specific nutrient depletion.

Path Parameters:

  • id - The unique identifier of the nutrient

Example Request:

GET https://api.needantidote.com/v1/partner/nutrient/depletion/metformin_vitamin_b12

Example Response:

{
  "data": {
    "id": "metformin_vitamin_b12",
    "name": "Vitamin B12",
    "reasons": "Long term treatment with Biguanides, such as Metformin or Metformin combinations with other drugs, are found in research to reduce vitamin B12 absorption due to...",
    "class": "Biguanides",
    "category": "Diabetes",
    "dose": "100mcg",
    "replacement": "Vitamin B12 (Methylcobalamin)",
    "evidence": "Pongchaidecha M, Srikusalanukul V, Chattananon A, Tanjariyaporn S. Effect of metformin on plasma homocysteine, vitamin B12 and folic acid..."
  }
}
GET/nutrient/support/:id

Returns details for a drug specific supporting nutrient.

Path Parameters:

  • id - The unique identifier of the nutrient

Example Request:

GET https://api.needantidote.com/v1/partner/nutrient/support/atorvastatin_magnesium

Example Response:

{
  "data": {
    "id": "atorvastatin_magnesium",
    "name": "Magnesium",
    "reasons": "Magnesium supplements and statin medications both inhibit the HMG-CoA...",
    "class": "Statin",
    "category": "Cholesterol",
    "dose": "75mg",
    "replacement": "Magnesium",
    "evidence": "Roxana Nartea, et al. The Link between Magnesium Supplements and Statin Medication..."
  }
}

Other Endpoints

GET/nutrients/beneficial/:conditionId

Returns beneficial nutrients for a specific condition.

Path Parameters:

  • conditionId - The unique identifier of the condition

Query Parameters:

  • limit (optional) - Maximum number of records to return (default: 100, max: 500)
  • skip (optional) - Number of records to skip for pagination (default: 0)

Example Request:

GET https://api.needantidote.com/v1/partner/nutrients/beneficial/antidepressants?limit=10

Example Response:

{
  "data": [
    {
      "evidence": "Jacka FN, Maes M, Pasco JA, Williams LJ, Berk M. Nutrient intakes and the...",
      "name": "Magnesium",
      "reasons": "Magnesium is a mineral that plays a crucial role in many bodily functions...",
      "conditionId": "antidepressants"
    },
    {
      "evidence": "Pasco JA, Jacka FN, Williams LJ, Evans-Cleverdon M, Brennan SL, Kotowicz MA, Nicholson GC, Ball MJ, Berk M. Dietary selenium and major depression...",
      "name": "Selenium",
      "reasons": "Selenium is a mineral that has emerged as a potential player in mood regulation...",
      "conditionId": "antidepressants"
    },
    ...
  ],
  "pagination": {
    "limit": 10,
    "skip": 0,
    "hasMore": false
  }
}
GET/drug-names/:name

Returns potential alternative names for a drug.

Path Parameters:

  • name - The name of the drug to find alternatives for

Example Request:

GET https://api.needantidote.com/v1/partner/drug-names/atorvastatin

Example Response:

{
  "data": {
    "name": "atorvastatin",
    "alternatives": [
      "atorvastatin calcium",
      "amlodipine besylate and atorvastatin calcium",
      "amlodipine and atorvastatin"
    ]
  }
}

Response Format

All successful responses follow a consistent format with a data property containing the requested information. List endpoints include a pagination object.

Error responses include an error property with a description of what went wrong.

Error Response Example:

{
  "error": "Resource not found"
}

Status Codes

CodeDescription
200 OKRequest succeeded
400 Bad RequestInvalid request parameters
404 Not FoundResource not found
500 Internal Server ErrorServer error occurred