Disease API

Overview

The Disease API provides comprehensive access to a vast dataset of over 10,000 diseases, supporting the health tech community in building more informed and efficient systems. With capabilities for both fuzzy and exact match searches, pagination, conditional detail inclusion, and sorting, this API is designed to serve a wide range of applications, from diagnostic tools to educational platforms.

For Definitions see API dictionary

Endpoint

GET https://www.britelink.io/api/v1/diseases

Authorization Header

To access the API, include an authorization header with your request:

Header	Value
Authorization	Bearer YOUR_API_KEY

Replace YOUR_API_KEY with the API key you receive upon registration or from your API management dashboard.

Making a Request

Example Request using cURL

curl -X GET "https://www.britelink.io/api/v1/diseases" \
     -H "Authorization: Bearer YOUR_API_KEY"

Example Request using JavaScript

const apiKey = "YOUR_API_KEY"; // Replace with your API key
const apiUrl = "https://www.britelink.io/api/v1/diseases";

fetch(apiUrl, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${apiKey}`,
  },
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error:", error));

Request Parameters

Customize your query with the following parameters:

Parameter	Type	Description	Required
`n`	string	The disease name to search for, supporting both fuzzy and exact matches.	No
`e`	boolean	If `true`, performs an exact match search. Default is fuzzy search.	No
`r`	boolean	Include detailed references (`true`) or just disease names (`false`). Default is `true`.	No
`s`	boolean	Enable alphabetical sorting of disease names (`true`). Default is `false`.	No
`sOrder`	string	Sort order: `asc` for ascending, `desc` for descending. Default is `asc`.	No
`b`	integer	Batch size for pagination, up to a maximum of 250. Default is 25.	No
`cursor`	string	Cursor for pagination, indicating the starting point for the next batch of results.	No

Responses

HTTP 200: Success, returns a list of diseases.
HTTP 404: No matching diseases found.
HTTP 500: Internal server error.

Response Format

Responses are structured as JSON, providing either basic or detailed information per the r parameter, along with pagination support through nextCursor.

Basic Information Response

{
  "diseases": [
    {
      "Disease_Name": "Acute Radiation Syndrome"
      // Additional entries...
    }
  ],
  "nextCursor": "nextCursorString"
}

Detailed Information Response (When `r=true`)

{
  "diseases": [
    {
      "id": "1",
      "Disease_Name": "Acute Radiation Syndrome",
      "Disease_ID": "ARS123",
      "Alternative_Disease_IDs": "ARS321",
      "Definition": "A condition caused by exposure to a high dose of radiation...",
      "Parent_IDs": "PARENT123",
      "Tree_Numbers": "TREE123",
      "Parent_Tree_Numbers": "PARENT_TREE123",
      "Synonyms": ["Radiation Sickness", "Radiation Poisoning"],
      "Slim_Mappings": ["Mapping1", "Mapping2"]
      // Additional details...
    }
    // Additional disease entries...
  ],
  "nextCursor": "nextCursorString"
}

Use Cases

Medical Research Platforms: Enhance research tools with detailed disease data, supporting studies on prevalence, treatment efficacy, and epidemiological trends.
Healthcare Applications: Integrate disease information to support diagnostic accuracy, patient education, and treatment planning.
Public Health Informatics: Use the API to track disease trends, inform public health strategies, and educate the public on health risks and preventions.
Educational Tools: Incorporate detailed disease information into learning resources for medical students and professionals.

Best Practices

Utilize URL encoding for the n parameter to handle spaces or special characters.
Employ the nextCursor for efficient pagination, facilitating access to large datasets without performance compromise. See more on pagination

BriteAPI