{"ok":true,"site":"clinicaltrials","host":"clinicaltrials.gov","about":"ClinicalTrials.gov (NIH/NLM registry of over 600k clinical studies). The CLI searches studies, fetches full study records and their version history, autocompletes conditions, interventions, sponsors and facilities, and returns registry statistics and field metadata, all through the site's internal /api/int endpoints.","commands":[{"command":"search-studies","summary":"Search or list clinical studies by condition, keyword, intervention, sponsor, location or NCT IDs, with facet filters, sorting and offset paging. Returns compact study hits.","params":[{"name":"cond","type":"string","description":"Condition or disease search area, e.g. 'breast cancer'. Use suggest --dictionary Condition for canonical terms."},{"name":"term","type":"string","description":"Other terms: free-text search over NCT ID, acronym, titles, keywords and more. Supports Essie expression syntax (AND/OR/NOT, AREA[Field]value)."},{"name":"intr","type":"string","description":"Intervention or treatment search area, e.g. 'tamoxifen'"},{"name":"spons","type":"string","description":"Sponsor or collaborator name search area"},{"name":"locStr","type":"string","description":"Location text, e.g. 'Boston, Massachusetts'"},{"name":"ids","type":"string","description":"Restrict to these NCT IDs, comma-separated, e.g. NCT00001372,NCT04368728"},{"name":"aggFilters","type":"string","description":"Facet filters as comma-separated 'facetId:key key' groups, e.g. 'status:rec not,sex:f'. Facet ids and keys come from the aggFilters block of count-studies (e.g. status keys: not=not yet recruiting, re"},{"name":"sort","type":"string","description":"Sort order: '@relevance', or 'FieldPiece:asc|desc', e.g. 'LastUpdatePostDate:desc' or 'StartDate:desc'","default":"@relevance"},{"name":"api_fields","type":"string","description":"Comma-separated field pieces to return (see get-field-metadata) (sent to the site as \"fields\"; clify's own --fields only shapes the output)","default":"NCTId,BriefTitle,OverallStatus,LastKnownStatus,StatusVerifiedDate,HasResults,Condition,InterventionType,InterventionName,Phase,StudyType,LeadSponsorName,StartDate,PrimaryCompletionDate,EnrollmentCount,LocationFacility,LocationCity,LocationState,LocationCountry,LastUpdatePostDate"},{"name":"from","type":"number","description":"Result offset (0-based)","default":0},{"name":"api_limit","type":"number","description":"Results per page (the UI uses up to 100) (sent to the site as \"limit\"; clify's own --limit only shapes the output)","default":20}],"exampleUrl":"https://clify-dev.netlify.app/clinicaltrials/search-studies?cond=breast+cancer&ids=NCT00001372"},{"command":"count-studies","summary":"Get the total number of matching studies and per-facet counts (status, sex, phase, study type, …) for a search, without listing studies.","params":[{"name":"cond","type":"string","description":"Condition or disease search area"},{"name":"term","type":"string","description":"Other terms / Essie expression"},{"name":"intr","type":"string","description":"Intervention or treatment search area"},{"name":"spons","type":"string","description":"Sponsor or collaborator search area"},{"name":"locStr","type":"string","description":"Location text"},{"name":"ids","type":"string","description":"Comma-separated NCT IDs"},{"name":"aggFilters","type":"string","description":"Facet filters, e.g. 'status:rec'"}],"exampleUrl":"https://clify-dev.netlify.app/clinicaltrials/count-studies?ids=NCT00001372"},{"command":"get-study","summary":"Get the full record of one study by NCT ID: protocol (description, eligibility, arms, outcomes, locations, contacts), results if posted, and derived data. Uses the public REST API v2.","params":[{"name":"nctId","type":"string","required":true,"description":"NCT identifier, 'NCT' followed by 8 digits"},{"name":"api_fields","type":"string","description":"Comma-separated field pieces or section names to return, e.g. 'NCTId,BriefTitle,EligibilityCriteria' or 'ProtocolSection'. Leave empty for the full record. (Sent to the site as \"fields\".)"},{"name":"markupFormat","type":"string","description":"Format of rich-text fields","oneOf":["markdown","legacy"],"default":"markdown"}],"exampleUrl":"https://clify-dev.netlify.app/clinicaltrials/get-study"},{"command":"suggest","summary":"Autocomplete or normalize a condition, intervention, lead sponsor or facility name before searching.","params":[{"name":"input","type":"string","required":true,"description":"Partial text to complete, e.g. 'tamox'"},{"name":"dictionary","type":"string","required":true,"description":"Which vocabulary to search","oneOf":["Condition","InterventionName","LeadSponsorName","LocationFacility"]}],"exampleUrl":"https://clify-dev.netlify.app/clinicaltrials/suggest?input=breast+cancer&dictionary=Condition"},{"command":"get-field-metadata","summary":"Get the study data structure: every field with its piece name (used in fields/sort/AREA[] expressions), type, description and rules.","params":[{"name":"includeIndexedOnly","type":"boolean","description":"Include fields that are indexed only (searchable but not part of the record)","default":true},{"name":"includeHistoricOnly","type":"boolean","description":"Include fields that exist only in historic versions of records","default":false}],"exampleUrl":"https://clify-dev.netlify.app/clinicaltrials/get-field-metadata"},{"command":"list-search-areas","summary":"List the search areas (term, cond, intr, …), their query param names, and the weighted fields each one searches.","params":[],"exampleUrl":"https://clify-dev.netlify.app/clinicaltrials/list-search-areas"},{"command":"get-stats","summary":"Get registry statistics: total studies, recruiting and registered counts by location and study type, registrations and results by year, and the last update date.","params":[],"exampleUrl":"https://clify-dev.netlify.app/clinicaltrials/get-stats"},{"command":"get-api-spec","summary":"Get the OpenAPI 3 (YAML) spec of the public ClinicalTrials.gov REST API v2, the reference for query syntax, filters and field names.","params":[],"exampleUrl":"https://clify-dev.netlify.app/clinicaltrials/get-api-spec"}]}