Skip to main content
Version: Latest

CompanyFilter

description

Only one of ids, include, exclude, watchlists fields should be provided, except when both include and watchlists are used together.

input CompanyFilter {
ids: [String!]
include: [String!]
exclude: [String!]
watchlists: [String!]
primaryOnly: Boolean
query: String
}

Fields

CompanyFilter.ids ● [String!] list scalar graph-ql-types

Only documents related to the given companies will be included to the search results. Alias for "include". Might be deprecated in the future versions.

CompanyFilter.include ● [String!] list scalar graph-ql-types

Only documents related to the given companies will be included to the search results. Accepts ticker symbols or ISINs, or other means of company identifiers.

CompanyFilter.exclude ● [String!] list scalar graph-ql-types

Documents related to the given companies will be excluded from the search results. Accepts ticker symbols or ISINs, or other means of company identifiers.

CompanyFilter.watchlists ● [String!] list scalar graph-ql-types

Use watchlists to pass a list of watchlists ids. When using watchlists, "ids", "include", "exclude" filters are not allowed.

CompanyFilter.primaryOnly ● Boolean scalar graph-ql-types

If set to true, the filter will search for matches across primary companies only. Otherwise (and by default), it'll search across both primary and secondary companies.

CompanyFilter.query ● String scalar graph-ql-types

It is a comma separated list, including company ids and names with or without minus sign

Member Of

SearchFilter input