Search
Changed onSearch for entities by label, with optional filters
Args: q (str, optional): Query string. Defaults to ":". category (str, optional): Filter by biolink model category. Defaults to None. in_taxon (str, optional): Filter by taxon CURIE. Defaults to None. in_taxon_label (str, optional): Filter by taxon label. Defaults to None. namespace (str, optional): Restrict to these CURIE namespaces. Defaults to None. exclude_namespace (str, optional): Drop these CURIE namespaces. Defaults to None. subset (str, optional): Restrict to entities in these ontology subsets. Defaults to None. exclude_subset (str, optional): Drop entities in these ontology subsets. Defaults to None. scope (SearchScope, optional): A named filter bundle. Supplies category, namespace, subset, exclude_subset and in_taxon where they were not passed explicitly; an explicit value wins for that axis. The resolved filters are echoed on the response. Defaults to None. facets (bool, optional): True facets every filterable field with no cap on values, which is how a caller discovers what namespace and subsets accept. False disables faceting. Omitted keeps the historical category + in_taxon_label counts. Defaults to None. match_type (SearchMatchType, optional): relevance (default) or exact. In exact mode a result is returned only when q equals the entity's name or one of its exact synonyms as a whole string, case-insensitively; otherwise the result set is empty. Items carry matched_field and match_type so callers can apply their own precision policy. Defaults to relevance. include_phenotypes (bool, optional): Include phenotype annotations and closures. Defaults to False. include_descendants (bool, optional): Include ontology descendants. Defaults to False. offset (int, optional): Offset for pagination. Defaults to 0. limit (int, optional): Limit results. Defaults to 20.
Returns: EntityResults
Request
- Base URLhttps://monarchinitiative.org (the document declares no server; this is the origin it was published from)
- URLhttps://monarchinitiative.org/v3/api/search
- Authnone declared
Query parameters
The named filter bundles /search?scope= accepts.
How strict /search should be about what counts as a hit.
relevance is the search contract: maximise recall and always return the best available hit. exact is the grounding contract: return an entity only when the query names it, and an empty result set otherwise.
Include the entity's phenotype annotations and their closures. Large: these are most of the response when present.
Include the entity's ontology descendants. Large: these are most of the response when present.
Response
Successful Response
Changes
- info
added the new optional
queryrequest parameterexclude_namespace - info
added the new optional
queryrequest parameterexclude_subset - info
added the new optional
queryrequest parameterfacets - info
added the new optional
queryrequest parameterin_taxon - info
added the new optional
queryrequest parameterinclude_descendants - info
added the new optional
queryrequest parameterinclude_phenotypes - info
added the new optional
queryrequest parametermatch_type - info
added the new optional
queryrequest parameternamespace - info
added the new optional
queryrequest parameterscope - info
added the new optional
queryrequest parametersubset - info
added the enum value
biolink:ClinicalMeasurementto the propertyanyOf[subschema #1]/items/of thequeryrequest parametercategory - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
to the response with the status
- info