Collections

Set up a collection

Create a collection of any type from a few plain fields; the full source/filter configuration is built server-side, exactly as the in-app agent builds it. Requires the write scope. Regulatory collections require regulatory access on the account. For stock portfolios, tickers are validated and unknown ones come back in invalid_tickers.

post/collections/setup

Request

  • Base URL: https://studio.fintechstudios.com/api/v1
  • URL: https://studio.fintechstudios.com/api/v1/collections/setup
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

type'news' | 'stock_portfolio' | 'regulatory' | 'prediction_markets'
namestring required
querystring required
descriptionstring
keywordsstring[]
tickersstring[]

stock_portfolio

jurisdictionsstring[]

regulatory

agenciesstring[]

regulatory

focus_areasstring[]

regulatory

exchangesstring[]

prediction_markets

topicsstring[]

prediction_markets

Response

{ collection, invalid_tickers }

Changes

No recorded changes to this operation across all 1 revision of this API.