TickWriteAPI QSG v1.0
TickAPI® Quick Start Guide Version 1.0
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 1 of 13
Table of Contents Utilization of the TickAPI®…………………………………………………………………………………………………………..3 Authentication....................................................................................................................... 3 Parameters ............................................................................................................................ 3 help?with=country ........................................................................................................................ 3 help?with=type ............................................................................................................................. 4 help?with=New_Symbol ............................................................................................................... 5 First Simple TickAPI® Call ....................................................................................................... 6 Single symbol trades ..................................................................................................................... 6 Multiple Symbol Trades ................................................................................................................ 7 Additional Features................................................................................................................ 8 help?with=PARAMETERS .............................................................................................................. 8 help?with=Fields ........................................................................................................................... 9 Appendix A – help?with details………………………………………………………………………………………………..11 Servlet Name ....................................................................................................................... 11 Arguments for with .............................................................................................................. 11 Additional Parameters ......................................................................................................... 11 Matrix ................................................................................................................................. 12 Parameter Usage ................................................................................................................. 12 Examples ............................................................................................................................. 13
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 2 of 13
Utilization of the TickAPI® The basis of Tick Data’s TickAPI® is a HTTPS GET request. The format of the request follows a general pattern: https://tickapi.tickdata.com/stream?<requestParameters> The request parameters base themselves off of the market of the request. There are potential values that are valid for some markets and collection types that are not applicable for other markets or collection types (i.e. Granularity is only applicable to a bar collection type; it would not be applicable for trade or quote data.). A request has 2 main parts: Authentication and Parameters.
Authentication Access to the API is controlled via HTTP authentication. The authentication follows the REST-API standards of HTTP BASIC authentication over HTTPS. The format of the Authorization header is: Authorization: Basic userid:password The user ID and password are encoded using the base-64 encoding scheme. RFC 2617, HTTP Authentication: Basic and Digest Access Authentication, available from http://www.ietf.org/rfc/rfc2617.txt, has more detailed information about basic authentication.
Parameters To support the proper generation of API calls, the <requestParameters> can be requested from the help?with web service. The help?with web service, like the TickAPI® webservice utilizes the same authentication. Requests to the help?with web service will allow a user to determine what are valid values to send in an api call. This document will use the example of constructing an API request for Australian Trades from 07 Feb 2013 until 8 Feb 2013 for company WEBJET LIMITED. help?with=country A first help?with call might be help?with=country. The return, in CSV, JSON or XML of this call will present a list of the available markets for based on the account information provided at login. Example: https://tickapi.tickdata.com/help?with=Country DESCRIPTION,VALUE,ALT_DESCRIPTION London Stock Exchange,COLLECTION_TYPE.LN,MARKET.LSE Bolsa de Madrid,COLLECTION_TYPE.MADRID,MARKET.MADRID Indices,COLLECTION_TYPE.INDEXES,MARKET.INDICES
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 3 of 13
Indicators,COLLECTION_TYPE.INDICATORS,MARKET.INDICATORS Forex,COLLECTION_TYPE.FOREX,MARKET.FOREX Euronext Paris Stock Exchange,COLLECTION_TYPE.EU_PARIS,MARKET.EURONEXT Euronext Amsterdam Stock Exchange,COLLECTION_TYPE.EU_AMSTERDAM,MARKET.EURONEXT Euronext Brussels Stock Exchange,COLLECTION_TYPE.EU_BRUSSELS,MARKET.EURONEXT Euronext Lisbon Stock Exchange,COLLECTION_TYPE.EU_LISBON,MARKET.EURONEXT Euronext Stock Exchange (Integrated),COLLECTION_TYPE.EU_INTEGRATED,MARKET.EURONEXT U.S. Equities,COLLECTION_TYPE.US_TED,MARKET.US_TED Borsa Italiana Exchange,COLLECTION_TYPE.IT,MARKET.ITALY Hong Kong Stock Exchange,COLLECTION_TYPE.HONG_KONG,MARKET.HONG_KONG Bolsa Mexicana de Valores (BMV),COLLECTION_TYPE.MEXICO,MARKET.MEXICO Korean Stock Exchange,COLLECTION_TYPE.KOREA,MARKET.KOREA Futures,COLLECTION_TYPE.FUTURES,MARKET.FUTURES Deutsche Borse Exchange (XETRA),COLLECTION_TYPE.GR,MARKET.GERMANY BM&F Bovespa,COLLECTION_TYPE.BRAZIL,MARKET.BRAZIL Japanese Tick Equity Data,COLLECTION_TYPE.NIKKEI,MARKET.JAPAN Australian Stock Exchange,COLLECTION_TYPE.AUSTRALIA,MARKET.AUSTRALIA Toronto Stock Exchange,COLLECTION_TYPE.TSX,MARKET.TSX
The above information can also be accessed in XML or JSON with the as parameter in the above call: /help?with=Country&as=JSON {"OUTPUT": [ { "description" : "London Stock Exchange","value" : "COLLECTION_TYPE.LN","alt_description" : "MARKET.LSE"},{ "description" : "Bolsa de Madrid","value" : "COLLECTION_TYPE.MADRID","alt_description" : "MARKET.MADRID"},{ "description" : "Indices","value" : "COLLECTION_TYPE.INDEXES","alt_description" : "MARKET.INDICES"},{ "description" : "Indicators","value" : "COLLECTION_TYPE.INDICATORS","alt_description" : "MARKET.INDICATORS"},{ "description" : "Forex","value" : "COLLECTION_TYPE.FOREX","alt_description" : "MARKET.FOREX"},{ "description" : "Euronext Paris Stock Exchange","value" : "COLLECTION_TYPE.EU_PARIS","alt_description" : "MARKET.EURONEXT"},{ "description" : "Euronext Amsterdam Stock Exchange","value" : "COLLECTION_TYPE.EU_AMSTERDAM","alt_description" : "MARKET.EURONEXT"},{ "description" : "Euronext Brussels Stock Exchange","value" : "COLLECTION_TYPE.EU_BRUSSELS","alt_description" : "MARKET.EURONEXT"},{ "description" : "Euronext Lisbon Stock Exchange","value" : "COLLECTION_TYPE.EU_LISBON","alt_description" : "MARKET.EURONEXT"},{ "description" : "Euronext Stock Exchange (Integrated)","value" : "COLLECTION_TYPE.EU_INTEGRATED","alt_description" : "MARKET.EURONEXT"},{ "description" : "U.S. Equities","value" : "COLLECTION_TYPE.US_TED","alt_description" : "MARKET.US_TED"},{ "description" : "Borsa Italiana Exchange","value" : "COLLECTION_TYPE.IT","alt_description" : "MARKET.ITALY"},{ "description" : "Hong Kong Stock Exchange","value" : "COLLECTION_TYPE.HONG_KONG","alt_description" : "MARKET.HONG_KONG"},{ "description" : "Bolsa Mexicana de Valores (BMV)","value" : "COLLECTION_TYPE.MEXICO","alt_description" : "MARKET.MEXICO"},{ "description" : "Korean Stock Exchange","value" : "COLLECTION_TYPE.KOREA","alt_description" : "MARKET.KOREA"},{ "description" : "Futures","value" : "COLLECTION_TYPE.FUTURES","alt_description" : "MARKET.FUTURES"},{ "description" : "Deutsche Borse Exchange (XETRA)","value" : "COLLECTION_TYPE.GR","alt_description" : "MARKET.GERMANY"},{ "description" : "BM&F Bovespa","value" : "COLLECTION_TYPE.BRAZIL","alt_description" : "MARKET.BRAZIL"},{ "description" : "Japanese Tick Equity Data","value" : "COLLECTION_TYPE.NIKKEI","alt_description" : "MARKET.JAPAN"},{ "description" : "Australian Stock Exchange","value" : "COLLECTION_TYPE.AUSTRALIA","alt_description" : "MARKET.AUSTRALIA"},{ "description" : "Toronto Stock Exchange","value" : "COLLECTION_TYPE.TSX","alt_description" : "MARKET.TSX"}]}
help?with=type Given a particular market, such as (Australian Stock Exchange, COLLECTION_TYPE.AUSTRALIA, MARKET.AUSTRALIA) The output from this Market lookup can be used to find the appropriate collectors from the help?with method: /help?with=type&for=COLLECTION_TYPE.AUSTRALIA DESCRIPTION,VALUE,ALT_VALUE Trades,COLLECTOR_SUBTYPE_AUSTRALIA_TRADES,COLLECTION_TYPE.AUSTRALIA
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 4 of 13
Tick Based Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICKBAR,COLLECTION_TYPE.AUSTRALIA Time Based Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICK_TIMEBAR,COLLECTION_TYPE.AUSTRALIA Daily Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICK_DAILYBAR,COLLECTION_TYPE.AUSTRALIA Weekly Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICK_WEEKLYBAR,COLLECTION_TYPE.AUSTRALIA Monthly Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICK_MONTHLYBAR,COLLECTION_TYPE.AUSTRALIA Quotes,COLLECTOR_SUBTYPE_AUSTRALIA_QUOTES,COLLECTION_TYPE.AUSTRALIA
In this example, we will show the XML as well: /help?with=type&for=COLLECTION_TYPE.AUSTRALIA&as=XML <description>Company Info Only COLLECTOR_SUBTYPE_AUSTRALIA_COMPANY_INFO_ONLY COLLECTION_TYPE.AUSTRALIA <description>Trades COLLECTOR_SUBTYPE_AUSTRALIA_TRADES COLLECTION_TYPE.AUSTRALIA <description>Tick Based Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICKBAR COLLECTION_TYPE.AUSTRALIA <description>Time Based Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICK_TIMEBAR COLLECTION_TYPE.AUSTRALIA <description>Daily Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICK_DAILYBAR COLLECTION_TYPE.AUSTRALIA <description>Weekly Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICK_WEEKLYBAR COLLECTION_TYPE.AUSTRALIA <description>Monthly Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICK_MONTHLYBAR COLLECTION_TYPE.AUSTRALIA <description>Quotes COLLECTOR_SUBTYPE_AUSTRALIA_QUOTES COLLECTION_TYPE.AUSTRALIA
The value contained herein, COLLECTOR_SUBTYPE_AUSTRALIA_TRADES will be an essential value to our API Call. This value is also essential to the rest of our help?with calls. help?with=New_Symbol To complete the lookup phase to build this simple job, use: TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 5 of 13
/help?with=New_Symbol&for=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES&filter=SYMBOL|like|W E DESCRIPTION,VALUE,ALT_DESCRIPTION WEBJET LIMITED,517|WEB[20140103],2007-06-25 - 2068-07-19 WHITE ENERGY CO LTD,1704|WEC[20140103],2006-07-03 - 2068-07-19 WESFARMERS LTD,3050|WESNA[20140103],2001-04-17 - 2009-02-23 CATALPA RESOURCES LTD,3715|WEZ[20140103],2002-08-20 - 2008-09-02 WESFARMERS LTD,5992|WESN[20140103],2013-11-27 - 2013-12-06 WESFARMERS LTD,7571|WES[20140103],2013-11-27 - 2068-07-19 WHITE EAGLE RESOURCES LTD,7888|WEG[20140103],2013-02-05 - 2068-07-19 WESFARMERS LTD-CUM DIV,8619|WESCD[20140103],2002-03-04 - 2068-07-19 WHITE EAGLE RESOURCES LTD,9182|WEGNA[20140103],2013-10-28 - 2013-11-06 SPDR S&P EMERGING MARKETS FUND,9193|WEMG[20140103],2013-11-04 - 2068-07-19
First Simple TickAPI® Call Single symbol trades Now, utilizing the values obtained: COLLECTION_TYPE EXTRACT_TYPE REQUESTED_DATE START_DATE END_DATE API Call:
COLLECTION_TYPE.AUSTRALIA COLLECTOR_SUBTYPE_AUSTRALIA_TRADES 517|WEB[20140103] 02/07/2013 02/08/2013
https://tickapi.tickdata.com/stream? COLLECTION_TYPE=COLLECTION_TYPE.AUSTRALIA&EXTRACT_TYPE=COLLECTOR_SUBTYPE_AUS TRALIA_TRADES&REQUESTED_DATA=517|WEB[20140103]&START_DATE=02/07/2013&END_D ATE=02/08/2013 02/07/2013,10:09:22.001,5.02,200,2,, 02/07/2013,10:09:25.736,5.02,3708,0,, 02/07/2013,10:09:25.736,5.02,532,0,, 02/07/2013,10:09:26.749,5.02,120,0,, 02/07/2013,10:09:52.641,5.01,1725,0,, 02/07/2013,10:09:52.641,5.01,67,0,, 02/07/2013,10:10:41.363,5.01,233,0,, 02/07/2013,10:10:41.363,5.01,36,0,, 02/07/2013,10:10:41.363,5.01,32,0,, 02/07/2013,10:10:41.375,5.01,175,0,, 02/07/2013,10:10:42.369,5.01,111,0,, 02/07/2013,10:10:59.940,5.0,1708,0,, 02/07/2013,10:10:59.940,5.0,2000,0,, 02/07/2013,10:10:59.940,5.0,1010,0,, 02/07/2013,10:10:59.940,5.0,32,0,, 02/07/2013,10:10:59.940,5.0,250,0,, 02/07/2013,10:11:00.642,4.99,1028,0,,
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 6 of 13
Multiple Symbol Trades NOTE: MULTIPLE SYMBOLS PER REQUEST ONLY AVAILABLE VIA DOWNLOAD. Requests for multiple symbols can be made the same way, utilizing comma separated values in the REQUESTED_DATA field. NOTE: /download calls require a NOTIFICATION_EMAIL field. COLLECTION_TYPE EXTRACT_TYPE REQUESTED_DATA START_DATE END_DATE API Call:
COLLECTION_TYPE.AUSTRALIA COLLECTOR_SUBTYPE_AUSTRALIA_TRADES 517|WEB[20140103],7571|WES[20140103] 02/07/2013 02/08/2013
https://tickapi.tickdata.com/download?COLLECTION_TYPE=COLLECTION_TYPE.AUSTRALIA&EXT RACT_TYPE=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES&REQUESTED_DATA=517|WEB[201401 03],7571|WES[20140103]&START_DATE=02/07/2013&END_DATE=02/10/2013&NOTIFICATION [email protected] The output of the above call would be a zip file with the CSV’s included inside of it.
Where symbols are not ambiguous, they can be called directly: COLLECTION_TYPE EXTRACT_TYPE REQUESTED_DATE START_DATE END_DATE
COLLECTION_TYPE.AUSTRALIA COLLECTOR_SUBTYPE_AUSTRALIA_TRADES WEB,WES 02/07/2013 02/08/2013
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 7 of 13
API Call: https://tickapi.tickdata.com/download?COLLECTION_TYPE=COLLECTION_TYPE.AUSTRALIA&EXT RACT_TYPE=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES&REQUESTED_DATA=WEB,WES&START _DATE=02/07/2013&END_DATE=02/08/[email protected]
Additional Features help?with=PARAMETERS Next to find the possible additional parameters for our request, the call is help?with=PARAMETERS&for=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES DESCRIPTION,VALUE START_HOUR,java.lang.String DESTINATION_DIRECTORY,java.lang.String PRICE_MOVEMENT_DB_REPORT,java.lang.Boolean OUTPUT_FILE_NAME,java.lang.String VWAP_PRICE_ADJUSTMENT_SCALE,java.lang.Integer END_DATE,java.util.Date PRICE_DECIMALS,java.lang.String FILTERS,java.util.ArrayList TIME_FORMAT,java.lang.String INTERVAL_TYPE,java.lang.String COLLECTION_OUTPUT_TYPE,java.lang.String TIME_GAP_REPORT,java.lang.Boolean PRICE_MULTIPLIER,java.lang.String COLLECT_ALL_SYMBOLS,java.lang.Boolean MAP_DATE,java.util.Date VWAP_STRIP_ZEROES,java.lang.Boolean EMAIL_OUT,java.lang.String DATE_FORMAT,java.lang.String USE_END_TIME,java.lang.Boolean START_DATE,java.util.Date OUTPUT_TIME_ZONE,java.lang.String GENERATE_LOG_FILE,java.lang.Boolean RUN_COLLECTION_VALIDATION_ONLY,java.lang.Boolean JOB_NUMBER,java.lang.Integer USE_START_TIME,java.lang.Boolean TIME_GAP_REPORT_ONLY,java.lang.Boolean OUTPUT_FILE_EXTENSION,java.lang.String TOTAL_NUMBER_OF_JOBS,java.lang.Integer NOTIFICATION_LIST,java.lang.String PRICE_MOVEMENT_REPORT,java.lang.Boolean EXTRACT_TYPE,java.lang.String ZIP_RESULTS,java.lang.Boolean CACHE_OBJECT,java.lang.String SPLIT_ADJUST,java.lang.Boolean INCLUDE_CORPORATE_ACTIONS,java.lang.Boolean INCLUDE_EXCLUDED_RECORDS,java.lang.Boolean OUTPUT_FILE_PREFIX,java.lang.String OVERWRITE_EXISTING,java.lang.Boolean
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 8 of 13
COLLECTION_TYPE,java.lang.String COMPRESSION_TYPE,java.lang.String END_HOUR,java.lang.String SESSIONS,java.util.Set WORKING_JOB,java.lang.Boolean DAYS_BACK,java.lang.String CUSTOM_HEADER,java.lang.String MOVEMENT_REPORT_FILE_NAME,java.lang.String MAX_DESTINATION_FILE_SIZE,java.lang.Integer AS_OF_DATE,java.util.Date START_MINUTE,java.lang.String NOTIFICATION_EMAIL,java.lang.String INCLUDE_HEADER_ROW,java.lang.Boolean SELECTED_FIELDS,java.util.List REQUESTED_DATA,java.util.Set REPORT_FILE_NAME,java.lang.String IGNORE_FILTERED_PRICE,java.lang.Boolean END_MINUTE,java.lang.String OUTPUT_TO,java.lang.String OUTPUT_FILE_SUFFIX,java.lang.String OUTPUT_NAMING_CONVENTION,java.lang.Integer DELIMITER,java.lang.String
help?with=Fields There are certain parameters that do need additional explanation. One example is SELECTED_FIELDS. There is another call to help with the possible values for Selected Fields: help?with=Fields&for=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES DESCRIPTION,VALUE,ALT_DESCRIPTION Date,DATE_FIELD,0 Time,TICK_TIME_FIELD,5 Price,PRICE_FIELD,1 Volume,VOLUME_FIELD,2 Sales Condition,SALES_CONDITION_FIELD,3 Exclude Record Flag,EXCLUDE_RECORD_FLAG_FIELD,3 Filtered Price,FILTERED_PRICE_FIELD,1 Symbol,SYMBOL_FIELD,3 VWAP,VWAP_FIELD,1 Company ID,COMPANY_ID_FIELD,3 Date and Time,DATE_AND_TIME_FIELD,4
COLLECTION_TYPE EXTRACT_TYPE REQUESTED_DATE START_DATE END_DATE CUSTOM_HEADER INCLUDE_HEADER_ROW DATE_FORMAT SELECTED_FIELDS
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
COLLECTION_TYPE.AUSTRALIA COLLECTOR_SUBTYPE_AUSTRALIA_TRADES WEB,WES 20130207 20130208 Company,Date,Amount,Cost true yyyyMMdd SYMBOL_FIELD|DATE_FIELD|VOLUME_FIELD|PRICE_FIELD
Page 9 of 13
API Call: https://tickapi.tickdata.com/download?COLLECTION_TYPE=COLLECTION_TYPE.AUSTRALIA&EXTRACT_TY PE=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES&REQUESTED_DATA=WEB,WES&START_DATE=20130207 &END_DATE=20130208&DATE_FORMAT=yyyyMMdd&CUSTOM_HEADER=Company,Date,Amount,Cost &SELECTED_FIELDS=SYMBOL_FIELD|DATE_FIELD|VOLUME_FIELD|PRICE_FIELD&INCLUDE_HEADER_RO [email protected]
Output of the above call will be a zip file with two files inside. The contents of the each file resemble this: Company,Date,Amount,Cost WEB,20130207,200,5.02 WEB,20130207,3708,5.02 WEB,20130207,532,5.02 WEB,20130207,120,5.02 WEB,20130207,1725,5.01
…
Company,Date,Amount,Cost WES,20130207,560,38.35 WES,20130207,14,38.35 WES,20130207,2700,38.32 WES,20130207,300,38.32 WES,20130207,62,38.35
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 10 of 13
Appendix A – help?with details https://tickapi.tickdata.com/help?with
Servlet Name with
Arguments for with Country/MARKET Type/SUBTYPE new_symbol dateformat
timeformat
field parameters roll_method adjustment_by
sessions timezone compression
This will list the countries and country collector types licensed by the user. This will list the extract types (EXTRACT_TYPEs) licensed by the user. Aliases are not listed. This will list the symbol and company names available. This will list the possible date formats to be used in a request. NOTE: The date format must be sent on the TickAPI® request if using an alternate format. This will list the possible time formats to be used in a request. NOTE: The time format must be sent on the TickAPI® request if using an alternative format. Returns a list of fields for output on a given type of job. Returns a list of acceptable parameters for a given type of job. Returns acceptable values for roll_method parameter: (AUTO_ROLL, EXPIRATION_ROLL, DAY_TO_ROLL) Returns acceptable adjustment_by values. (ADJUSTMENT_TYPE_NONE, ADJUSTMENT_TYPE_FORWARD, ADJUSTMENT_TYPE_BACKWARDS) Returns accetpable sessions choices Returns acceptable output timezone values Returns acceptable compression type choices. Currently NONE,ZIP,GZIP
Additional Parameters for on as filter
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Used with country, type and symbol to limit the output. Used with symbol to input a date for the symbol lookup. Used to determine the output of data, options are JSON, CSV and XML. Used with symbol to search by company name or symbol id
Page 11 of 13
Matrix Column1 country type new_symbol dateformat timeformat
for X X X
on
As filter X X X X X X
Parameter Usage Country
For As
Use for to limit the country output by extract type Use as to determine output format: JSON, XML, CSV
Type
For As
Use for to limit the country output by country type Use as to determine output format: JSON, XML, CSV
new_symbol
For
REQUIRED: Use an above Type to help select a value / values
As Filter
Use as to determine output format: JSON, XML, CSV Use filter to control the output. Usage: | This will use the operator against the symbol_id Example: like|AG This will look for symbols that start with AG || This will allow user to specify the field, the operator, and value compare to Example: company_name|=|XEROX This will look for symbols where the company name ="XEROX "
dateformat
As
Use as to determine output format: JSON, XML, CSV
timeformat
As
Use as to determine output format: JSON, XML, CSV
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 12 of 13
Examples https://tickapi.tickdata.com/help?with=country COLLECTION_TYPE_NAME,COLLECTION_TYPE_ID
https://tickapi.tickdata.com/help?with=type COLLECTION_TYPE_ID,SUB_TYPE_NAME,SUB_TYPE_ID
https://tickapi.tickdata.com/help?with=type&for=COLLECTION_TYPE.US_TED COLLECTION_TYPE_ID,SUB_TYPE_NAME,SUB_TYPE_ID
https://tickapi.tickdata.com/help?with=date https://tickapi.tickdata.com/help?with=dateformat DATE_FORMAT
https://tickapi.tickdata.com/help?with=timeformat https://tickapi.tickdata.com/help?with=time TIME_FORMAT
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 13 of 13
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 1 of 13
Table of Contents Utilization of the TickAPI®…………………………………………………………………………………………………………..3 Authentication....................................................................................................................... 3 Parameters ............................................................................................................................ 3 help?with=country ........................................................................................................................ 3 help?with=type ............................................................................................................................. 4 help?with=New_Symbol ............................................................................................................... 5 First Simple TickAPI® Call ....................................................................................................... 6 Single symbol trades ..................................................................................................................... 6 Multiple Symbol Trades ................................................................................................................ 7 Additional Features................................................................................................................ 8 help?with=PARAMETERS .............................................................................................................. 8 help?with=Fields ........................................................................................................................... 9 Appendix A – help?with details………………………………………………………………………………………………..11 Servlet Name ....................................................................................................................... 11 Arguments for with .............................................................................................................. 11 Additional Parameters ......................................................................................................... 11 Matrix ................................................................................................................................. 12 Parameter Usage ................................................................................................................. 12 Examples ............................................................................................................................. 13
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 2 of 13
Utilization of the TickAPI® The basis of Tick Data’s TickAPI® is a HTTPS GET request. The format of the request follows a general pattern: https://tickapi.tickdata.com/stream?<requestParameters> The request parameters base themselves off of the market of the request. There are potential values that are valid for some markets and collection types that are not applicable for other markets or collection types (i.e. Granularity is only applicable to a bar collection type; it would not be applicable for trade or quote data.). A request has 2 main parts: Authentication and Parameters.
Authentication Access to the API is controlled via HTTP authentication. The authentication follows the REST-API standards of HTTP BASIC authentication over HTTPS. The format of the Authorization header is: Authorization: Basic userid:password The user ID and password are encoded using the base-64 encoding scheme. RFC 2617, HTTP Authentication: Basic and Digest Access Authentication, available from http://www.ietf.org/rfc/rfc2617.txt, has more detailed information about basic authentication.
Parameters To support the proper generation of API calls, the <requestParameters> can be requested from the help?with web service. The help?with web service, like the TickAPI® webservice utilizes the same authentication. Requests to the help?with web service will allow a user to determine what are valid values to send in an api call. This document will use the example of constructing an API request for Australian Trades from 07 Feb 2013 until 8 Feb 2013 for company WEBJET LIMITED. help?with=country A first help?with call might be help?with=country. The return, in CSV, JSON or XML of this call will present a list of the available markets for based on the account information provided at login. Example: https://tickapi.tickdata.com/help?with=Country DESCRIPTION,VALUE,ALT_DESCRIPTION London Stock Exchange,COLLECTION_TYPE.LN,MARKET.LSE Bolsa de Madrid,COLLECTION_TYPE.MADRID,MARKET.MADRID Indices,COLLECTION_TYPE.INDEXES,MARKET.INDICES
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 3 of 13
Indicators,COLLECTION_TYPE.INDICATORS,MARKET.INDICATORS Forex,COLLECTION_TYPE.FOREX,MARKET.FOREX Euronext Paris Stock Exchange,COLLECTION_TYPE.EU_PARIS,MARKET.EURONEXT Euronext Amsterdam Stock Exchange,COLLECTION_TYPE.EU_AMSTERDAM,MARKET.EURONEXT Euronext Brussels Stock Exchange,COLLECTION_TYPE.EU_BRUSSELS,MARKET.EURONEXT Euronext Lisbon Stock Exchange,COLLECTION_TYPE.EU_LISBON,MARKET.EURONEXT Euronext Stock Exchange (Integrated),COLLECTION_TYPE.EU_INTEGRATED,MARKET.EURONEXT U.S. Equities,COLLECTION_TYPE.US_TED,MARKET.US_TED Borsa Italiana Exchange,COLLECTION_TYPE.IT,MARKET.ITALY Hong Kong Stock Exchange,COLLECTION_TYPE.HONG_KONG,MARKET.HONG_KONG Bolsa Mexicana de Valores (BMV),COLLECTION_TYPE.MEXICO,MARKET.MEXICO Korean Stock Exchange,COLLECTION_TYPE.KOREA,MARKET.KOREA Futures,COLLECTION_TYPE.FUTURES,MARKET.FUTURES Deutsche Borse Exchange (XETRA),COLLECTION_TYPE.GR,MARKET.GERMANY BM&F Bovespa,COLLECTION_TYPE.BRAZIL,MARKET.BRAZIL Japanese Tick Equity Data,COLLECTION_TYPE.NIKKEI,MARKET.JAPAN Australian Stock Exchange,COLLECTION_TYPE.AUSTRALIA,MARKET.AUSTRALIA Toronto Stock Exchange,COLLECTION_TYPE.TSX,MARKET.TSX
The above information can also be accessed in XML or JSON with the as parameter in the above call: /help?with=Country&as=JSON {"OUTPUT": [ { "description" : "London Stock Exchange","value" : "COLLECTION_TYPE.LN","alt_description" : "MARKET.LSE"},{ "description" : "Bolsa de Madrid","value" : "COLLECTION_TYPE.MADRID","alt_description" : "MARKET.MADRID"},{ "description" : "Indices","value" : "COLLECTION_TYPE.INDEXES","alt_description" : "MARKET.INDICES"},{ "description" : "Indicators","value" : "COLLECTION_TYPE.INDICATORS","alt_description" : "MARKET.INDICATORS"},{ "description" : "Forex","value" : "COLLECTION_TYPE.FOREX","alt_description" : "MARKET.FOREX"},{ "description" : "Euronext Paris Stock Exchange","value" : "COLLECTION_TYPE.EU_PARIS","alt_description" : "MARKET.EURONEXT"},{ "description" : "Euronext Amsterdam Stock Exchange","value" : "COLLECTION_TYPE.EU_AMSTERDAM","alt_description" : "MARKET.EURONEXT"},{ "description" : "Euronext Brussels Stock Exchange","value" : "COLLECTION_TYPE.EU_BRUSSELS","alt_description" : "MARKET.EURONEXT"},{ "description" : "Euronext Lisbon Stock Exchange","value" : "COLLECTION_TYPE.EU_LISBON","alt_description" : "MARKET.EURONEXT"},{ "description" : "Euronext Stock Exchange (Integrated)","value" : "COLLECTION_TYPE.EU_INTEGRATED","alt_description" : "MARKET.EURONEXT"},{ "description" : "U.S. Equities","value" : "COLLECTION_TYPE.US_TED","alt_description" : "MARKET.US_TED"},{ "description" : "Borsa Italiana Exchange","value" : "COLLECTION_TYPE.IT","alt_description" : "MARKET.ITALY"},{ "description" : "Hong Kong Stock Exchange","value" : "COLLECTION_TYPE.HONG_KONG","alt_description" : "MARKET.HONG_KONG"},{ "description" : "Bolsa Mexicana de Valores (BMV)","value" : "COLLECTION_TYPE.MEXICO","alt_description" : "MARKET.MEXICO"},{ "description" : "Korean Stock Exchange","value" : "COLLECTION_TYPE.KOREA","alt_description" : "MARKET.KOREA"},{ "description" : "Futures","value" : "COLLECTION_TYPE.FUTURES","alt_description" : "MARKET.FUTURES"},{ "description" : "Deutsche Borse Exchange (XETRA)","value" : "COLLECTION_TYPE.GR","alt_description" : "MARKET.GERMANY"},{ "description" : "BM&F Bovespa","value" : "COLLECTION_TYPE.BRAZIL","alt_description" : "MARKET.BRAZIL"},{ "description" : "Japanese Tick Equity Data","value" : "COLLECTION_TYPE.NIKKEI","alt_description" : "MARKET.JAPAN"},{ "description" : "Australian Stock Exchange","value" : "COLLECTION_TYPE.AUSTRALIA","alt_description" : "MARKET.AUSTRALIA"},{ "description" : "Toronto Stock Exchange","value" : "COLLECTION_TYPE.TSX","alt_description" : "MARKET.TSX"}]}
help?with=type Given a particular market, such as (Australian Stock Exchange, COLLECTION_TYPE.AUSTRALIA, MARKET.AUSTRALIA) The output from this Market lookup can be used to find the appropriate collectors from the help?with method: /help?with=type&for=COLLECTION_TYPE.AUSTRALIA DESCRIPTION,VALUE,ALT_VALUE Trades,COLLECTOR_SUBTYPE_AUSTRALIA_TRADES,COLLECTION_TYPE.AUSTRALIA
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 4 of 13
Tick Based Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICKBAR,COLLECTION_TYPE.AUSTRALIA Time Based Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICK_TIMEBAR,COLLECTION_TYPE.AUSTRALIA Daily Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICK_DAILYBAR,COLLECTION_TYPE.AUSTRALIA Weekly Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICK_WEEKLYBAR,COLLECTION_TYPE.AUSTRALIA Monthly Bars,COLLECTOR_SUBTYPE_AUSTRALIA_TICK_MONTHLYBAR,COLLECTION_TYPE.AUSTRALIA Quotes,COLLECTOR_SUBTYPE_AUSTRALIA_QUOTES,COLLECTION_TYPE.AUSTRALIA
In this example, we will show the XML as well: /help?with=type&for=COLLECTION_TYPE.AUSTRALIA&as=XML <description>Company Info Only COLLECTOR_SUBTYPE_AUSTRALIA_COMPANY_INFO_ONLY COLLECTION_TYPE.AUSTRALIA <description>Trades COLLECTOR_SUBTYPE_AUSTRALIA_TRADES COLLECTION_TYPE.AUSTRALIA <description>Tick Based Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICKBAR COLLECTION_TYPE.AUSTRALIA <description>Time Based Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICK_TIMEBAR COLLECTION_TYPE.AUSTRALIA <description>Daily Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICK_DAILYBAR COLLECTION_TYPE.AUSTRALIA <description>Weekly Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICK_WEEKLYBAR COLLECTION_TYPE.AUSTRALIA <description>Monthly Bars COLLECTOR_SUBTYPE_AUSTRALIA_TICK_MONTHLYBAR COLLECTION_TYPE.AUSTRALIA <description>Quotes COLLECTOR_SUBTYPE_AUSTRALIA_QUOTES COLLECTION_TYPE.AUSTRALIA
The value contained herein, COLLECTOR_SUBTYPE_AUSTRALIA_TRADES will be an essential value to our API Call. This value is also essential to the rest of our help?with calls. help?with=New_Symbol To complete the lookup phase to build this simple job, use: TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 5 of 13
/help?with=New_Symbol&for=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES&filter=SYMBOL|like|W E DESCRIPTION,VALUE,ALT_DESCRIPTION WEBJET LIMITED,517|WEB[20140103],2007-06-25 - 2068-07-19 WHITE ENERGY CO LTD,1704|WEC[20140103],2006-07-03 - 2068-07-19 WESFARMERS LTD,3050|WESNA[20140103],2001-04-17 - 2009-02-23 CATALPA RESOURCES LTD,3715|WEZ[20140103],2002-08-20 - 2008-09-02 WESFARMERS LTD,5992|WESN[20140103],2013-11-27 - 2013-12-06 WESFARMERS LTD,7571|WES[20140103],2013-11-27 - 2068-07-19 WHITE EAGLE RESOURCES LTD,7888|WEG[20140103],2013-02-05 - 2068-07-19 WESFARMERS LTD-CUM DIV,8619|WESCD[20140103],2002-03-04 - 2068-07-19 WHITE EAGLE RESOURCES LTD,9182|WEGNA[20140103],2013-10-28 - 2013-11-06 SPDR S&P EMERGING MARKETS FUND,9193|WEMG[20140103],2013-11-04 - 2068-07-19
First Simple TickAPI® Call Single symbol trades Now, utilizing the values obtained: COLLECTION_TYPE EXTRACT_TYPE REQUESTED_DATE START_DATE END_DATE API Call:
COLLECTION_TYPE.AUSTRALIA COLLECTOR_SUBTYPE_AUSTRALIA_TRADES 517|WEB[20140103] 02/07/2013 02/08/2013
https://tickapi.tickdata.com/stream? COLLECTION_TYPE=COLLECTION_TYPE.AUSTRALIA&EXTRACT_TYPE=COLLECTOR_SUBTYPE_AUS TRALIA_TRADES&REQUESTED_DATA=517|WEB[20140103]&START_DATE=02/07/2013&END_D ATE=02/08/2013 02/07/2013,10:09:22.001,5.02,200,2,, 02/07/2013,10:09:25.736,5.02,3708,0,, 02/07/2013,10:09:25.736,5.02,532,0,, 02/07/2013,10:09:26.749,5.02,120,0,, 02/07/2013,10:09:52.641,5.01,1725,0,, 02/07/2013,10:09:52.641,5.01,67,0,, 02/07/2013,10:10:41.363,5.01,233,0,, 02/07/2013,10:10:41.363,5.01,36,0,, 02/07/2013,10:10:41.363,5.01,32,0,, 02/07/2013,10:10:41.375,5.01,175,0,, 02/07/2013,10:10:42.369,5.01,111,0,, 02/07/2013,10:10:59.940,5.0,1708,0,, 02/07/2013,10:10:59.940,5.0,2000,0,, 02/07/2013,10:10:59.940,5.0,1010,0,, 02/07/2013,10:10:59.940,5.0,32,0,, 02/07/2013,10:10:59.940,5.0,250,0,, 02/07/2013,10:11:00.642,4.99,1028,0,,
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 6 of 13
Multiple Symbol Trades NOTE: MULTIPLE SYMBOLS PER REQUEST ONLY AVAILABLE VIA DOWNLOAD. Requests for multiple symbols can be made the same way, utilizing comma separated values in the REQUESTED_DATA field. NOTE: /download calls require a NOTIFICATION_EMAIL field. COLLECTION_TYPE EXTRACT_TYPE REQUESTED_DATA START_DATE END_DATE API Call:
COLLECTION_TYPE.AUSTRALIA COLLECTOR_SUBTYPE_AUSTRALIA_TRADES 517|WEB[20140103],7571|WES[20140103] 02/07/2013 02/08/2013
https://tickapi.tickdata.com/download?COLLECTION_TYPE=COLLECTION_TYPE.AUSTRALIA&EXT RACT_TYPE=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES&REQUESTED_DATA=517|WEB[201401 03],7571|WES[20140103]&START_DATE=02/07/2013&END_DATE=02/10/2013&NOTIFICATION [email protected] The output of the above call would be a zip file with the CSV’s included inside of it.
Where symbols are not ambiguous, they can be called directly: COLLECTION_TYPE EXTRACT_TYPE REQUESTED_DATE START_DATE END_DATE
COLLECTION_TYPE.AUSTRALIA COLLECTOR_SUBTYPE_AUSTRALIA_TRADES WEB,WES 02/07/2013 02/08/2013
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 7 of 13
API Call: https://tickapi.tickdata.com/download?COLLECTION_TYPE=COLLECTION_TYPE.AUSTRALIA&EXT RACT_TYPE=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES&REQUESTED_DATA=WEB,WES&START _DATE=02/07/2013&END_DATE=02/08/[email protected]
Additional Features help?with=PARAMETERS Next to find the possible additional parameters for our request, the call is help?with=PARAMETERS&for=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES DESCRIPTION,VALUE START_HOUR,java.lang.String DESTINATION_DIRECTORY,java.lang.String PRICE_MOVEMENT_DB_REPORT,java.lang.Boolean OUTPUT_FILE_NAME,java.lang.String VWAP_PRICE_ADJUSTMENT_SCALE,java.lang.Integer END_DATE,java.util.Date PRICE_DECIMALS,java.lang.String FILTERS,java.util.ArrayList TIME_FORMAT,java.lang.String INTERVAL_TYPE,java.lang.String COLLECTION_OUTPUT_TYPE,java.lang.String TIME_GAP_REPORT,java.lang.Boolean PRICE_MULTIPLIER,java.lang.String COLLECT_ALL_SYMBOLS,java.lang.Boolean MAP_DATE,java.util.Date VWAP_STRIP_ZEROES,java.lang.Boolean EMAIL_OUT,java.lang.String DATE_FORMAT,java.lang.String USE_END_TIME,java.lang.Boolean START_DATE,java.util.Date OUTPUT_TIME_ZONE,java.lang.String GENERATE_LOG_FILE,java.lang.Boolean RUN_COLLECTION_VALIDATION_ONLY,java.lang.Boolean JOB_NUMBER,java.lang.Integer USE_START_TIME,java.lang.Boolean TIME_GAP_REPORT_ONLY,java.lang.Boolean OUTPUT_FILE_EXTENSION,java.lang.String TOTAL_NUMBER_OF_JOBS,java.lang.Integer NOTIFICATION_LIST,java.lang.String PRICE_MOVEMENT_REPORT,java.lang.Boolean EXTRACT_TYPE,java.lang.String ZIP_RESULTS,java.lang.Boolean CACHE_OBJECT,java.lang.String SPLIT_ADJUST,java.lang.Boolean INCLUDE_CORPORATE_ACTIONS,java.lang.Boolean INCLUDE_EXCLUDED_RECORDS,java.lang.Boolean OUTPUT_FILE_PREFIX,java.lang.String OVERWRITE_EXISTING,java.lang.Boolean
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 8 of 13
COLLECTION_TYPE,java.lang.String COMPRESSION_TYPE,java.lang.String END_HOUR,java.lang.String SESSIONS,java.util.Set WORKING_JOB,java.lang.Boolean DAYS_BACK,java.lang.String CUSTOM_HEADER,java.lang.String MOVEMENT_REPORT_FILE_NAME,java.lang.String MAX_DESTINATION_FILE_SIZE,java.lang.Integer AS_OF_DATE,java.util.Date START_MINUTE,java.lang.String NOTIFICATION_EMAIL,java.lang.String INCLUDE_HEADER_ROW,java.lang.Boolean SELECTED_FIELDS,java.util.List REQUESTED_DATA,java.util.Set REPORT_FILE_NAME,java.lang.String IGNORE_FILTERED_PRICE,java.lang.Boolean END_MINUTE,java.lang.String OUTPUT_TO,java.lang.String OUTPUT_FILE_SUFFIX,java.lang.String OUTPUT_NAMING_CONVENTION,java.lang.Integer DELIMITER,java.lang.String
help?with=Fields There are certain parameters that do need additional explanation. One example is SELECTED_FIELDS. There is another call to help with the possible values for Selected Fields: help?with=Fields&for=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES DESCRIPTION,VALUE,ALT_DESCRIPTION Date,DATE_FIELD,0 Time,TICK_TIME_FIELD,5 Price,PRICE_FIELD,1 Volume,VOLUME_FIELD,2 Sales Condition,SALES_CONDITION_FIELD,3 Exclude Record Flag,EXCLUDE_RECORD_FLAG_FIELD,3 Filtered Price,FILTERED_PRICE_FIELD,1 Symbol,SYMBOL_FIELD,3 VWAP,VWAP_FIELD,1 Company ID,COMPANY_ID_FIELD,3 Date and Time,DATE_AND_TIME_FIELD,4
COLLECTION_TYPE EXTRACT_TYPE REQUESTED_DATE START_DATE END_DATE CUSTOM_HEADER INCLUDE_HEADER_ROW DATE_FORMAT SELECTED_FIELDS
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
COLLECTION_TYPE.AUSTRALIA COLLECTOR_SUBTYPE_AUSTRALIA_TRADES WEB,WES 20130207 20130208 Company,Date,Amount,Cost true yyyyMMdd SYMBOL_FIELD|DATE_FIELD|VOLUME_FIELD|PRICE_FIELD
Page 9 of 13
API Call: https://tickapi.tickdata.com/download?COLLECTION_TYPE=COLLECTION_TYPE.AUSTRALIA&EXTRACT_TY PE=COLLECTOR_SUBTYPE_AUSTRALIA_TRADES&REQUESTED_DATA=WEB,WES&START_DATE=20130207 &END_DATE=20130208&DATE_FORMAT=yyyyMMdd&CUSTOM_HEADER=Company,Date,Amount,Cost &SELECTED_FIELDS=SYMBOL_FIELD|DATE_FIELD|VOLUME_FIELD|PRICE_FIELD&INCLUDE_HEADER_RO [email protected]
Output of the above call will be a zip file with two files inside. The contents of the each file resemble this: Company,Date,Amount,Cost WEB,20130207,200,5.02 WEB,20130207,3708,5.02 WEB,20130207,532,5.02 WEB,20130207,120,5.02 WEB,20130207,1725,5.01
…
Company,Date,Amount,Cost WES,20130207,560,38.35 WES,20130207,14,38.35 WES,20130207,2700,38.32 WES,20130207,300,38.32 WES,20130207,62,38.35
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 10 of 13
Appendix A – help?with details https://tickapi.tickdata.com/help?with
Servlet Name with
Arguments for with Country/MARKET Type/SUBTYPE new_symbol dateformat
timeformat
field parameters roll_method adjustment_by
sessions timezone compression
This will list the countries and country collector types licensed by the user. This will list the extract types (EXTRACT_TYPEs) licensed by the user. Aliases are not listed. This will list the symbol and company names available. This will list the possible date formats to be used in a request. NOTE: The date format must be sent on the TickAPI® request if using an alternate format. This will list the possible time formats to be used in a request. NOTE: The time format must be sent on the TickAPI® request if using an alternative format. Returns a list of fields for output on a given type of job. Returns a list of acceptable parameters for a given type of job. Returns acceptable values for roll_method parameter: (AUTO_ROLL, EXPIRATION_ROLL, DAY_TO_ROLL) Returns acceptable adjustment_by values. (ADJUSTMENT_TYPE_NONE, ADJUSTMENT_TYPE_FORWARD, ADJUSTMENT_TYPE_BACKWARDS) Returns accetpable sessions choices Returns acceptable output timezone values Returns acceptable compression type choices. Currently NONE,ZIP,GZIP
Additional Parameters for on as filter
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Used with country, type and symbol to limit the output. Used with symbol to input a date for the symbol lookup. Used to determine the output of data, options are JSON, CSV and XML. Used with symbol to search by company name or symbol id
Page 11 of 13
Matrix Column1 country type new_symbol dateformat timeformat
for X X X
on
As filter X X X X X X
Parameter Usage Country
For As
Use for to limit the country output by extract type Use as to determine output format: JSON, XML, CSV
Type
For As
Use for to limit the country output by country type Use as to determine output format: JSON, XML, CSV
new_symbol
For
REQUIRED: Use an above Type to help select a value / values
As Filter
Use as to determine output format: JSON, XML, CSV Use filter to control the output. Usage: | This will use the operator against the symbol_id Example: like|AG This will look for symbols that start with AG || This will allow user to specify the field, the operator, and value compare to Example: company_name|=|XEROX This will look for symbols where the company name ="XEROX "
dateformat
As
Use as to determine output format: JSON, XML, CSV
timeformat
As
Use as to determine output format: JSON, XML, CSV
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 12 of 13
Examples https://tickapi.tickdata.com/help?with=country COLLECTION_TYPE_NAME,COLLECTION_TYPE_ID
https://tickapi.tickdata.com/help?with=type COLLECTION_TYPE_ID,SUB_TYPE_NAME,SUB_TYPE_ID
https://tickapi.tickdata.com/help?with=type&for=COLLECTION_TYPE.US_TED COLLECTION_TYPE_ID,SUB_TYPE_NAME,SUB_TYPE_ID
https://tickapi.tickdata.com/help?with=date https://tickapi.tickdata.com/help?with=dateformat DATE_FORMAT
https://tickapi.tickdata.com/help?with=timeformat https://tickapi.tickdata.com/help?with=time TIME_FORMAT
TickAPI®: Quick Start Guide, v 1.0 Copyright 2014 by Tick Data, Inc.
Page 13 of 13
