Skip to main content

Python wrapper around the clinicaltrials.gov API

Project description

pytrials

https://img.shields.io/pypi/v/pytrials.svg https://github.com/jvfe/pytrials/workflows/pytest/badge.svg https://img.shields.io/pypi/l/pytrials Documentation Status

Python wrapper around the clinicaltrials.gov API. Documentation for the API can be found here: https://clinicaltrials.gov/api/

Tutorial

To install:

$ pip install pytrials

Basic Usage

from pytrials.client import ClinicalTrials

ct = ClinicalTrials()

# Get 50 full studies related to Coronavirus and COVID in csv format.
ct.get_full_studies(search_expr="Coronavirus+COVID", max_studies=50)

# Get the NCTId, Condition and Brief title fields from 1000 studies related to Coronavirus and Covid, in csv format.
corona_fields = ct.get_study_fields(
    search_expr="Coronavirus+COVID",
    fields=["NCT Number", "Conditions", "Study Title"],
    max_studies=1000,
    fmt="csv",
)

# Read the csv data in Pandas
import pandas as pd

pd.DataFrame.from_records(corona_fields[1:], columns=corona_fields[0])

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2020-07-06)

  • First release on PyPI.

0.1.2 (2020-07-11)

  • Minor fixes

0.2.0 (2021-04-24)

  • Improved test suite

  • Added get_study_count function

0.2.1 (2023-07-09)

  • Add classic prefix to url - #10

  • Raise error if API status is not ok - #11

0.3.0 (2023-07-09)

  • Add min_rnk option to get_study_fields - #12

1.0.0 (2024-05-01)

Migrates to version 2.0 of the ClinicalTrials API

  • Add support for the new API version

  • Add support for the new API fields

  • Remove get_study_count function

  • Allow CSV format in full_studies

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytrials-1.0.0.tar.gz (14.5 kB view hashes)

Uploaded Source

Built Distribution

pytrials-1.0.0-py2.py3-none-any.whl (7.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page