OpenTrials

OpenTrials API

OpenTrials API endpoints from OpenTrials

Data & analytics#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

OpenTrials API endpoints from OpenTrials

Endpoints 17

conditions

  • GETgetCondition/conditions/:idReturns condition details

document_categories

  • GETlistDocumentCategories/document_categoriesReturns document categories

documents

  • GETlistDocuments/documents?page=1&per_page=20Returns documents
  • GETgetDocument/documents/:idReturns details of a document

fda_applications

  • GETlistFDAApplications/fda_applications?page=1&per_page=20Returns FDA applications
  • GETgetFDAApplication/fda_applications/:idReturns an FDA application details

interventions

  • GETgetIntervention/interventions/:idReturns intervention details

organisations

  • GETgetOrganisation/organisations/:idReturns organisation details

persons

  • GETgetPerson/persons/:idReturns person details

publications

  • GETgetPublication/publications/:idReturns publication details

trials

  • GETsearchTrials/search?q=string&page=1&per_page=20Returns trials based on a search query. By default, it'll search in all of a trial's attributes. q is a ElasticSearch query string (e.g.…
  • GETgetTrial/trials/:idReturns a trial's details and related entities (e.g. conditions).
  • GETgetRecords/trials/:id/recordsReturns a trial's raw records from its sources
  • GETgetRecord/trials/:trialId/records/:idReturns a trial's raw record from its sources

search

  • GETautocomplete/search/autocomplete/:in?q=string&page=1&per_page=20Autocomplete search feature for supported database entities (location). It has the same options as a regular search operation, with an extra required in…
  • GETsearchFDADocuments/search/fda_documents?q=string&text=string&page=1&per_page=20Search the FDA documents

sources

  • GETlist/sourcesReturns list of sources

API details

Base URL
https://opentrials.local/v1
Authentication
None declared in the description
Operations
17 operations on 18 pathsGET 17
Main resources
trials 4documents 2fda_applications 2search 2conditions 1document_categories 1interventions 1organisations 1persons 1publications 1
Response formats
application/json
Description format
Swagger 2.0, API version 0.0.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the OpenTrials API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the OpenTrials API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “getCondition” (GET /conditions/:id), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the OpenTrials API?

OpenTrials API endpoints from OpenTrials It is listed under Data & analytics and has 17 endpoints.

Who publishes the OpenTrials API?

It is listed from OpenTrials's public API description (an OpenAPI document), not published by OpenTrials on Swastik Codes. Anyone who controls opentrials.net can claim the profile by adding a DNS TXT record.

What is the base URL of the OpenTrials API?

Requests go to https://opentrials.local/v1. Endpoint paths are added to this base URL.

How do I authenticate with the OpenTrials API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the OpenTrials API have?

17 operations on 18 paths (17 GET). The largest groups are trials, documents, fda_applications, search.

Is forking the OpenTrials API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.