Market data by id
You don't need to bring the data for a market. Search it, take its id, and pass the id to the analyses. This works in every plan, including without an account.
The flow
- Search.
search_symbols(MCP) orGET /api/data/SearchSymbols?search=Apple(REST). 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; -market_cycles/GET /api/cycles/MarketCycles/...: the dominant cycle of a market in one call; -consensus_score/GET /api/CycleConsensus/score/...: the consensus of a market in one call; -dtw_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.
Freshness
With an account (the trial, a plan or an account without a plan), the API brings a market's data up to date before it analyses it, at most once every six hours per symbol. Without an account the analysis runs on the data as it is stored.
What the answers contain, and what they leave out
The analyses return what the model measures: cycles, phases, projections, oscillators and scores. They do not return
the prices of a market. Without the feature MarketDataAccess, answers about market data leave out the price fields:
currentPrice, price, smoothedPrice, lastInputValue, preprocessedValues and indexedPerformance. The cycle
highlighter, the dominant cycle wave and the CRSI stay in.
For your own data nothing is left out. You sent the values, so you get them back.
What needs MarketDataAccess
The raw bars themselves are not part of any plan:
get_dataset,get_dataset_seriesand every route under/api/data/except the symbol search;update_dataset(loading the latest bars of a market into a dataset);- smoothing, detrending and the turning-point test with a market id (
sav_gol,sinc_smoother,detrend,rsd_test): their answer is the transformed series itself. With your own data they are open in every plan.
The feature is granted on request, for a project that needs market data by key. Without it these calls are answered
403 with a message that says so and names the way to analyse by id instead.
Your own datasets and streams
datasetid=<name> also names the datasets you stored with your key (store_dataset, PUT /api/datasets/{name}),
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
Market analyses count in their endpoint group (cycle analysis, consensus, DSP filters, DTW) and, for the GET analyses of a symbol, in the group "market analyses of a symbol" as well. 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.