Documentation¶
Locate API¶
APILocator.locate_apis_by_input_output_semantic_types(input_semantic_type, output_semantic_type)¶Find API to use based on input and output semantic types
Parameters:
- input_semantic_type (str) – The semantic type of the input, e.g. gene, pathway, chemical.
- output_semantic_type (str) – The semantic type of the output, e.g. gene, pathway, chemical.
Returns: list – api endpoints which can connect from input semantic type to output semantic type
APILocator.locate_apis_by_input_semantic_type_only(input_semantic_type)¶Find APIs which can take the input_semantic_type
Parameters: input_semantic_type (str) – The semantic type of the input, e.g. gene, pathway, chemical. Returns: list – api endpoints which can take the input semantic type
APILocator.locate_apis_by_output_semantic_type_only(output_semantic_type)¶Find APIs which can produce the output semantic type
Parameters: output_prefix (str) – The semantic type of the output, e.g. gene, pathway, chemical. Returns: list – api endpoints which can produce the output prefix
APILocator.locate_apis_by_input_output_prefix(input_prefix, output_prefix)¶Find API to use based on input and output prefixes
Parameters:
- input_prefix (str) – The prefix of the input, e.g. ncbigene, hgnc.symbol.
- output_prefix (str) – The prefix of the output, e.g. ncbigene, hgnc.symbol.
Returns: list – api endpoints which can connect from input prefix to output prefix
APILocator.locate_apis_by_input_prefix_only(input_prefix)¶Find APIs which can take the input_prefix
Parameters: input_prefix (str) – The prefix of the input, e.g. ncbigene, hgnc.symbol. Returns: list – api endpoints which can take the input prefix
APILocator.locate_apis_by_output_prefix_only(output_prefix)¶Find APIs which can produce the output_prefix
Parameters: output_prefix (str) – The prefix of the output, e.g. ncbigene, hgnc.symbol. Returns: list – api endpoints which can produce the output prefix
APILocator.locate_connected_apis_by_input_output_prefix(input_prefix, output_prefix, max_api=3)¶Find APIs which can be chained together to connect from input prefix to output prefix
Parameters:
- input_prefix (str) – The prefix of the input, e.g. ncbigene, hgnc.symbol.
- output_prefix (str) – The prefix of the output, e.g. ncbigene, hgnc.symbol.
Returns: list – api endpoints which can connect from input prefix to output prefix
Metadata¶
MetaData.list_all_api_resources()¶List all APIs integrated in BioThings Explorer
MetaData.list_all_endpoints()¶List all API endpoints integrated in BioThings Explorer
MetaData.list_all_semantic_types()¶List all semantic types used in BioThings Explorer
MetaData.list_all_prefixes(group_by_semantic_type=True)¶List all prefixes used in BioThings Explorer
MetaData.list_all_predicates()¶List all the predicates used in BioThings Explorer