Market data by id
Cycles IQ analyses the series you give it. The markets built into the app are a feature of their own, MarketDataAccess:
with it you don't need to bring the data for a market. Search it, take its id, and pass the id to the analyses, through
the REST API or through the MCP connector. No plan includes the feature; it is granted on request to known customers.
Without the feature every analysis takes your own data: values from another connector (a market-data connector, for
example), a file, your own numbers, or your stored datasets. A market id is answered 403 with a message that names the
feature and the way with your own data.
The flow
- Search.
GET /api/data/SearchSymbols?search=Apple, or the toolsearch_symbolsin the connector. Every hit carries asymbolId. - Analyse by id. Pass the id where an analysis takes a dataset:
-
datasetid=<symbolId>on the cycle explorer, the cycle scanner, the cyclic RSI, the consensus calculation, the cycle composite and the power scanner (the toolscycle_explorer,cycle_scanner,cyclic_rsi,consensus_score); -GET /api/cycles/MarketCycles/...: the dominant cycle of a market in one call (REST); -GET /api/CycleConsensus/score/...: the consensus of a market in one call (REST); - the DTW clustering (/api/dtw, the tooldtw_clustering): 2 to 20 ids at once, to see which markets move alike. - Read the cycles. The answer carries the cycles, their phases, the projections, the cycle highlighter and the CRSI, as it does for your own data. See Concepts.
Use the ids exactly as the search returns them.
Window and freshness
The API brings a market's data up to date before it analyses it, at most once every six hours per symbol. A market is
analysed over its last 1,250 days unless maxbars or from say otherwise, and every answer names what was analysed
(analysedWindow: the id, the first and the last bar's date, the number of bars).
What the answers contain, and what they leave out
The analyses return what the model measures: cycles, phases, projections, oscillators and scores. Through the REST API
the answers of a market analysis carry the price fields too (currentPrice, price, smoothedPrice, lastInputValue,
preprocessedValues, indexedPerformance). Through the MCP connector no answer carries prices, whoever asks: the
cycle highlighter, the dominant cycle wave and the CRSI stay in, the price fields are left out.
For your own data nothing is left out anywhere. You sent the values, so you get them back.
What the feature covers
- the symbol search and the analysis of a market by its id, through the REST API and the connector;
- the raw bars themselves: every route under
/api/data/(REST only; the connector has no tool for them); - smoothing, detrending and the turning-point test with a market id, through the REST API: their answer is the transformed series itself, so the connector never takes a market there. With your own data they are open everywhere.
The feature is granted on request to customers the administrator knows; no plan includes it, and an account that
registers and books a plan does not get it on its own. Ask through the support page. Without it these calls
are answered 403 with a message that says so and names the way with your own data.
Your own datasets and streams
datasetid=<name> also names the datasets you stored with your key (PUT /api/datasets/{name}, or store_dataset
through the MCP), the datasets you uploaded in the app and your own live streams. Datasets of other users are not open:
a call on another user's feed is refused with 403.
Limits
A market analysis counts once on your account, like every other call. The clustering takes 2 to 20 datasets, up to 5 cluster counts from 2 to 10, at most 10 repetitions and 1,000 bars back. See Plans and limits.
Answers of Cycles IQ are measurements and projections of cycles, not investment advice. Questions: support.