Collections

Revise collection filters

Merge filter changes into a collection: add/remove keywords, entities, exclusion terms and (stock portfolios) tickers; replace the query or regions. Anything not mentioned is kept — unlike PUT /collections/{id}, which replaces the whole filter object. Requires the write scope.

patch/collections/{id}/filters

Request

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

Path parameters

idstring required

Request body

querystring
keywordsstring[]

Replaces the keyword list.

add_keywordsstring[]
remove_keywordsstring[]
add_entitiesobject[]
remove_entitiesstring[]

Entity names.

add_exclude_termsstring[]
remove_exclude_termsstring[]
regionsstring[] nullable
add_tickersstring[]
remove_tickersstring[]

Response

{ collection, invalid_tickers }

Changes

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