clinicaltrials.gov explorer · GPT-Aktionen

{
  "openapi": "3.1.0",
  "info": {
    "title": "ClinicalTrials.gov APIs",
    "description": "APIs for retrieving detailed study data from ClinicalTrials.gov.",
    "version": "1.01.05"
  },
  "servers": [
    {
      "url": "https://clinicaltrials.gov/api"
    }
  ],
  "paths": {
    "/query/full_studies": {
      "get": {
        "description": "Fetches detailed information of a few studies based on the query expression.",
        "operationId": "GetFullStudies",
        "parameters": [
          {
            "name": "expr",
            "in": "query",
            "description": "Query expression to search for specific studies.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fmt",
            "in": "query",
            "description": "Format of the response, options include 'xml', 'json', 'csv'.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "xml",
                "json",
                "csv"
              ]
            }
          },
          {
            "name": "minRank",
            "in": "query",
            "description": "Starting number of a range of retrieved studies used to calculate the response.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "maxRank",
            "in": "query",
            "description": "Ending number of a range of retrieved studies used to calculate the response.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with details of studies.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FullStudiesResponse"
                }
              }
            }
          }
        },
        "deprecated": false
      }
    },
    "/query/study_fields": {
      "get": {
        "description": "Provides selected fields information for multiple studies.",
        "operationId": "GetStudyFields",
        "parameters": [
          {
            "name": "expr",
            "in": "query",
            "description": "Query expression to search for specific studies.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "Comma-separated list of fields to be included in the response.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fmt",
            "in": "query",
            "description": "Format of the response, options include 'xml', 'json', 'csv'.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "xml",
                "json",
                "csv"
              ]
            }
          },
          {
            "name": "minRank",
            "in": "query",
            "description": "Starting number of a range of retrieved studies used to calculate the response.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "maxRank",
            "in": "query",
            "description": "Ending number of a range of retrieved studies used to calculate the response.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with selected fields information.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StudyFieldsResponse"
                }
              }
            }
          }
        },
        "deprecated": false
      }
    },
    "/query/field_values": {
      "get": {
        "description": "Retrieves all values for a single study field for multiple studies.",
        "operationId": "GetFieldValues",
        "parameters": [
          {
            "name": "expr",
            "in": "query",
            "description": "Query expression to search for specific studies.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field",
            "in": "query",
            "description": "The study field for which values are to be retrieved.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fmt",
            "in": "query",
            "description": "Format of the response, options include 'xml', 'json', 'csv'.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "xml",
                "json",
                "csv"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with values for the specified field.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FieldValuesResponse"
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "FullStudiesResponse": {
        "type": "object",
        "properties": {
          "NStudiesReturned": {
            "type": "integer",
            "description": "Number of studies found within the specified rank range."
          },
          "FullStudy": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "Detailed study record."
            }
          }
        }
      },
      "StudyFieldsResponse": {
        "type": "object",
        "properties": {
          "NStudiesReturned": {
            "type": "integer",
            "description": "Number of studies found within the specified rank range."
          },
          "StudyFields": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "Selected field information for each study."
            }
          }
        }
      },
      "FieldValuesResponse": {
        "type": "object",
        "properties": {
          "NStudiesUsed": {
            "type": "integer",
            "description": "Number of studies used for the field values retrieval."
          },
          "FieldValues": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "Values for the specified study field."
            }
          }
        }
      }
    }
  }
}