The help API call takes a primary argument of with. With allows the caller to ask questions of TickWrite^® regarding what are the possible parameters, arguments and permutations for an API call. Click the help link (or click here) to explore the help possibilities. Also please view the Quick Start Guide for more information. The results from various help calls will allow the caller to validate parameter combinations as well as view specific values for parameters to be sent. (Example: ROLL_METHOD parameter allows for the possible values of AUTO_ROLL, EXPIRATION_ROLL or DAY_TO_ROLL. You can find this by asking: help?with=ROLL_METHOD )

The core of our Hosted Data Solution and main gate to requesting streaming mapped time series data, the /stream^® call requires as few as three parameters: EXTRACT_TYPE, REQUESTED_DATA, Time Frame (either START_DATE & END_DATE or DAYS_BACK).

However, /stream^® also accepts parameters for nearly every existing TickWrite^® feature and filter. One minute bars, custom headers, time and date formats and more are all available via API calls. Click the /stream^® link (or click here) to begin exploring the configuration possibilities. The links narrow each field, such that only viable options are shown as you move down a path.

A /download^® request will generate a TickWrite^® output file (or files) which can be retrieved at a later time via download link. /download^® requests use the same parameters as /stream^® requests, but can additionally return multiple symbols and files (including Company Info files), unlike /stream^® requests, which can only return one file per request.

tickmarket^® and ticksymbol^® calls were created to support our clients who cannot install software locally, but need as-traded Deep History source files. Unlike with /stream^® and /download^® methods, users of tickmarket^® and ticksymbol^® store Deep History data locally.