API Documentation

RX-Genes Clinical Disease API

API Documentation – Version 1

Overview

The RX-Genes Clinical Disease API provides authenticated access to the disease dataset stored within the RX-Genes database. The API allows authorized systems to retrieve disease records and associated clinical metadata, including gene associations, inheritance patterns, treatment information, references, and other related clinical fields.

This API is designed to support secure data access for applications, integrations, and analysis tools that require structured disease information.

All requests require authentication using a WordPress Application Password.

Requesting API Access

Access to the RX-Genes Clinical Disease API is restricted and requires authentication using a shared API user account.

How to Request Access

To request access, please send an email with the following information:

Your name and organization
Intended use of the API
Contact email address

Request Email

Please use the contact form.

Access Credentials

Upon approval, you will be provided with:

Username: apiaccess
Password: Application Password

The Application Password will be generated and securely shared with you.

Important Notes

The Application Password functions as your API key
Keep your credentials secure and do not share them publicly
If credentials are compromised, they can be revoked and regenerated
All API access is logged and monitored

Base URL

All API endpoints are accessed using the following base URL:

https://www.rx-genes.com/wp-json/disease-api/v1

Authentication

The API uses HTTP Basic Authentication with a WordPress Application Password.

Credentials

Username: api_access
Password: Application Password generated in WordPress

Example Request

curl -u "api_access:APPLICATION_PASSWORD" \
https://www.rx-genes.com/wp-json/disease-api/v1/all

All API requests must be made over HTTPS.

Get All Diseases Endpoint

Returns the full disease dataset.

Endpoint

GET /all

Example Request

https://www.rx-genes.com/wp-json/disease-api/v1/all

Example Response

[
  {
    "id": 1808,
    "name": "Hemochromatosis type 1",
    "slug": "hemochromatosis-type-1",
    "data": {
      "gene_name": "HFE",
      "inheritance": "AR",
      "current_treatment": "phlebotomy"
    }
  }
]

Get Disease by ID Endpoint

Returns a single disease record by its database ID.

Endpoint

GET /disease/{id}

Example

/wp-json/disease-api/v1/disease/1808

Example Response

{
  "id": 1808,
  "name": "Hemochromatosis type 1",
  "slug": "hemochromatosis-type-1",
  "data": {
    "gene_name": "HFE",
    "inheritance": "AR",
    "current_treatment": "phlebotomy"
  }
}

Get Disease by Slug Endpoint

Returns a single disease record using the disease slug.

Endpoint

GET /disease/{slug}

Example

/wp-json/disease-api/v1/disease/hemochromatosis-type-1

Get Diseases by Gene

Returns all diseases associated with a specific gene.

Endpoint

GET /gene/{gene}

Example

/wp-json/disease-api/v1/gene/HFE

Example Response

[
  {
    "id": 1808,
    "name": "Hemochromatosis type 1",
    "slug": "hemochromatosis-type-1",
    "data": {
      "gene_name": "HFE",
      "inheritance": "AR",
      "current_treatment": "phlebotomy"
    }
  }
]

Data Structure

Each disease object returned by the API contains the following fields.

Top Level Fields

Field	Description
id	WordPress database ID
name	Disease name
slug	URL-friendly identifier
data	Clinical metadata fields stored in ACF

Clinical Data Fields

The data object contains disease-specific metadata fields maintained within the RX-Genes database.

Examples include:

gene_name
genes_included_in_disease_frequency
inheritance
current_treatment
evidence_for_treatment
disease_frequency_per_100000
experimental_investigational_therapies
non-molecular_testing_availability
clingen
reference_1
reference_2
reference_3

Additional fields may be added over time as the dataset evolves.

Error Handling

If a record cannot be found, the API returns a standard REST error.

Example:

{
  "code": "not_found",
  "message": "Disease not found",
  "data": {
    "status": 404
  }
}

Security

The API is secured using WordPress authentication.

Security features include:

Authentication required for all endpoints
Access controlled through WordPress Application Passwords
HTTPS required for all requests
Credentials can be revoked at any time

Versioning

Current version:

v1

Future updates may introduce additional endpoints or expanded data fields.

Support

For technical questions or integration assistance, please contact the development team responsible for the RX-Genes platform.

This document can be shared with developers integrating with the RX-Genes disease dataset.