Download OpenAPI specification:Download
Provides programmatic access to RCSB search API.
required | object (Search Query) Search query. Must be URL-encoded. |
{- "query_id": "string",
- "result_type": "entry",
- "total_count": 1,
- "group_by_count": 1,
- "ungrouped_count": 1,
- "explain_metadata": {
- "total_timing": 0,
- "facet_timing": 0,
- "sort_timing": 0,
- "grouping_timing": 0,
- "terminal_node_timings": { }
}, - "result_set": [
- "string"
], - "facets": [
- {
- "name": "string",
- "buckets": [
- {
- "label": "string",
- "population": 0,
- "facets": [
- { }
]
}
]
}
], - "group_by": {
- "aggregation_method": "matching_deposit_group_id",
- "ranking_criteria_type": {
- "sort_by": "score",
- "filter": {
- "type": "group",
- "logical_operator": "or",
- "nodes": [
- {
- "type": "terminal",
- "parameters": {
- "value": "string",
- "attribute": "string",
- "negation": false,
- "operator": "equals",
- "case_sensitive": false
}
}
]
}, - "direction": "asc"
}
}, - "group_set": [
- "string"
]
}
object (Request Info) non-empty Information about the query. | |
object (Request Options) | |
return_type required | string (Return Type) Enum: "entry" "polymer_entity" "non_polymer_entity" "polymer_instance" "assembly" "mol_definition" Specifies the type of the returned identifiers. |
Group Node (object) or Terminal Node (object) Any valid query string as per the Search Aggregator query syntax is permitted. A search consists of one or more groups combined. |
{- "request_info": {
- "query_id": "string",
- "src": "ui"
}, - "request_options": {
- "results_content_type": [
- "experimental"
], - "results_verbosity": "compact",
- "facets": [
- {
- "name": "string",
- "aggregation_type": "terms",
- "attribute": "string",
- "min_interval_population": 1,
- "max_num_intervals": 65536,
- "facets": [ ]
}
], - "group_by": {
- "aggregation_method": "matching_deposit_group_id",
- "ranking_criteria_type": {
- "sort_by": "score",
- "filter": {
- "type": "group",
- "logical_operator": "or",
- "nodes": [
- {
- "type": "terminal",
- "parameters": {
- "value": "string",
- "attribute": "string",
- "negation": false,
- "operator": "equals",
- "case_sensitive": false
}
}
]
}, - "direction": "asc"
}
}, - "group_by_return_type": "groups",
- "sort": [
- {
- "sort_by": "score",
- "filter": {
- "type": "group",
- "logical_operator": "or",
- "nodes": [
- {
- "type": "terminal",
- "parameters": {
- "value": "string",
- "attribute": "string",
- "negation": false,
- "operator": "equals",
- "case_sensitive": false
}
}
]
}, - "direction": "asc"
}
], - "paginate": {
- "start": 0,
- "rows": 10
}, - "scoring_strategy": "combined",
- "return_all_hits": false,
- "return_counts": false,
- "return_explain_metadata": false
}, - "return_type": "entry",
- "query": {
- "type": "group",
- "logical_operator": "or",
- "nodes": [
- {
- "type": "terminal",
- "node_id": 0,
- "service": "full_text",
- "parameters": {
- "value": "string"
}, - "label": "string"
}
], - "label": "string"
}
}
{- "query_id": "string",
- "result_type": "entry",
- "total_count": 1,
- "group_by_count": 1,
- "ungrouped_count": 1,
- "explain_metadata": {
- "total_timing": 0,
- "facet_timing": 0,
- "sort_timing": 0,
- "grouping_timing": 0,
- "terminal_node_timings": { }
}, - "result_set": [
- "string"
], - "facets": [
- {
- "name": "string",
- "buckets": [
- {
- "label": "string",
- "population": 0,
- "facets": [
- { }
]
}
]
}
], - "group_by": {
- "aggregation_method": "matching_deposit_group_id",
- "ranking_criteria_type": {
- "sort_by": "score",
- "filter": {
- "type": "group",
- "logical_operator": "or",
- "nodes": [
- {
- "type": "terminal",
- "parameters": {
- "value": "string",
- "attribute": "string",
- "negation": false,
- "operator": "equals",
- "case_sensitive": false
}
}
]
}, - "direction": "asc"
}
}, - "group_set": [
- "string"
]
}
required | object (Unreleased Entry Search Query) Search query. Must be URL-encoded. |
{- "query_id": "string",
- "result_type": "unreleased_entry",
- "total_count": 0,
- "explain_metadata": {
- "total_timing": 0,
- "facet_timing": 0,
- "sort_timing": 0,
- "grouping_timing": 0,
- "terminal_node_timings": { }
}, - "result_set": [
- {
- "identifier": "string",
- "score": 0,
- "services": [
- {
- "service_type": "text",
- "nodes": [
- {
- "node_id": 0,
- "original_score": 0,
- "norm_score": 0,
- "match_context": [
- {
- "sequence_identity": 0,
- "evalue": 0,
- "bitscore": 0,
- "alignment_length": 0,
- "mismatches": 0,
- "gaps_opened": 0,
- "query_beg": 0,
- "query_end": 0,
- "subject_beg": 0,
- "subject_end": 0,
- "query_length": 0,
- "subject_length": 0,
- "query_aligned_seq": "string",
- "subject_aligned_seq": "string"
}
]
}
]
}
]
}
], - "facets": [
- {
- "name": "string",
- "buckets": [
- {
- "label": "string",
- "population": 0,
- "facets": [
- { }
]
}
]
}
]
}
required | object (Suggest Query) Suggest query. Must be URL-encoded. |
{- "took": 0,
- "suggestions": {
- "property1": [
- {
- "text": "string",
- "score": 0,
- "contexts": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
], - "property2": [
- {
- "text": "string",
- "score": 0,
- "contexts": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
]
}
}