ZINC15:Syntax
Jump to navigation
Jump to search
ZINC 15 uses a uniform set of rules to interpret the URL allowing both web pages and a machine-readable application programming interface (API). This page describes both.
Overall Syntax
The general forme of the ZINC15 URL is one of the following:
| http://zinc15.docking.org/<RESOURCE>/<ENDPOINT>[.<FORMAT>[:<FIELDS>]][?<PREDICATE_LIST>][&<PAGE_OPTIONS> |
|---|
| http://zinc15.docking.org/<RESOURCE-PHRASE>/having/<RESOURCE-PHRASE> |
The items in [ square brackets ] are optional. The items in < angled braces > are each described below.
- <RESOURCE> is an object type, such as molecules, catalogs or genes, and are fully described here: ZINC15:Resources
- <FORMAT> is one of the supported formats, such as smi, sdf, csv, fully described here: ZINC15:Formats. If a format is omitted, a webpage is implicitly requested.
- <FIELDS> are individual properties, including calculated ones, and are described together with the ZINC15:Resources to which they belong.
ZINC15:properties Not all properties make sense in all resource contexts. ZINC15:examples are provided. Each resource has default fields, if none are specified.
- <ENDPOINT> is one of (tile, table, detail, etc.) (only available if the underlying template exists); where items in [ square brackets ] are optional, and:
ZINC15:Variants.
- <PREDICATE_LIST> is a query string, one or more of <PREDICATE> delimited by &<PREDICATE> is <ATTRIBUTE>[:<OPERATOR>[;<OPERATOR_ARGS>]]=<THRESHOLD>
- ZINC15:Page Controls are optional, and are used to qualify how a search is to be performed and formatted for the page.
- https is currently not supported, but it will be.
Reserved words
- list, tile, subsets, help, overview - these have special meaning in the URL, and can never be the names of resources or their columns.
Examples
We illustrate the use of the website and the API with ZINC15:examples.
Back to ZINC15