The Quote Element
Description
Defines a sub-query of the
<Quotes>
element, requesting a (possibly large) group of
issues. Most account only have limited access to
collections, and often no access at all.
<Quote
collection =
string
filter =
"literal"
date-start =
datetime
date-end =
datetime
mode =
"literal"
max-count =
integer
last-issue-id =
integer
delivery-type =
"string"
realtime =
boolean />
Attributes
| Attribute name | Data type | Description |
|---|
| collection Required | string |
Tells the TBXDS engine to return quotes for this
collection. For example,
Euronext.Amsterdam.Shares.AEX.
See also Known Collections.
You can also specify "<collection>#<series>",
to make a sub-selection within the specified collection
(i.e., to select all options for Philips on the
AEX, you'd use the collection named
"Euronext.Amsterdam.Options.AEX#PHI").
You cannot use such collections in
combination with a filter.
|
| filter Optional | literal |
Indicates a filter on a collection. Available
filters are
| top-? | |
Most traded issues. ? can be 3, 5, 10 or 25.
| | risers-? | |
Top ? of risers. ? can be 3, 5, 10 or 25.
| | fallers-? | |
Top ? of fallers. ? can be 3, 5, 10 or 25.
|
If the output mode is set to "summary",
requesting a filtered and a non-filtered
collection, can cause repeated issue nodes.
|
| date-start Optional | datetime |
Gives the date (and time) from when
quotes should be returned, and before
which quotes should be ignored. This attribute
is used to retrieve historical price
data (in combination with date-end).
You need a subscription to retrieve historical
data.
|
| date-end Optional | datetime |
Gives the date up to when
quotes should be returned. This setting is used
in combination with date-start to return
historical price data.
Note 1
Cannot be used in combination with a filter.
Note 2
The realtime attribute has no effect in
combination with this attribute.
|
| mode Optional | literal |
(Value = "default|summary|trade")
The output mode; "default" generates a
structured <Issue> node,
and "summary" and "trade" simple
<Issue> (bulk) nodes, though with
different content.
|
| max-count Optional | integer |
Indicates the maximum number of issues returned
through this collection request. The collection
of the issues can be resumed through the
<LastPublishedId> mechanism
and last-issue-id.
|
| last-issue-id Optional | integer |
Resumes collecting data from the specified
collection, max-count issues at a time.
|
| delivery-type Optional | string |
Indicates what kind of quotes you want to receive:
real-time (realtime),
delayed (delay) or
end of day (endofday).
You need a subscription for the particular kind
you request.
|
| realtime Optional | boolean | yes is equivalent to delivery-type =
realtime.
|
Number of occurences
Unlimited
Occurs within
<Quotes> |
<TBMDataRequest>Can contain
None (element is closed).
See also
<Quote> (ticker) |
<BookDepth> |
<Quote> (response) |
Known Collections