ZINC15:Syntax

From DISI
Revision as of 21:02, 25 March 2015 by Frodo (talk | contribs) (asdf)
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. The general form of the ZINC15 URL is:

http[s]://host/resource[.format[:properties][/variant][?page-view-controls | resource-constraints]

where items in [ square brackets ] are optional, and:

  • host = zinc15.docking.org. during beta it is something else. ask us.
  • resource is one of the 15 ZINC15:Resources. By far the most common are substances, catalogs and genes.
  • format is one of the 12 ZINC15:Formats. If omitted, a web page is requested.
  • properties is one or more of the ZINC15:properties. Not all properties make sense in all resource contexts. ZINC15:Examples are provided. There are sensible defaults for each resource, so the property specification may be omitted.
  • variant is optionally one or more of the supported ZINC15:Variants.
  • ZINC15:Page Controls are optional, and are used to qualify how a search is to be performed and formatted for the page.
  • ZINC15:Constraints are optional, and may be qualified with ZINC15:Query operators

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.


We illustrate the use of the website and the API with ZINC15:examples.

The new interface is described in a set of web accessible tools that exemplify its use:

YouTube videos

Python scripts

iPython Notebooks

  • as well as numerous examples in the Results, available online at ZINC15:examples.


Back to ZINC15