List filters for a resource
Return the filterable fields and columns available for a resource — the same field set its search endpoint accepts. A browsable version of this vocabulary is published in the [filter & column reference](https://docs.pulseintelligence.com/docs/guides/filter-reference).
Authorization
apiKeyAuth Organization API key, format pulse_<prefix>_<secret>. Created by an organization admin in Settings -> API Keys.
In: header
Path Parameters
The resource to describe filters for: companies or mining-assets.
Value in
- "companies"
- "mining-assets"
Response Body
The resource's filter/column vocabulary.
The resource's current filter vocabulary: every filterable field and every response column its search endpoint accepts.
curl -X GET "https://example.com/v1/filters/companies/" \ -H "Authorization: Bearer $PULSE_API_KEY"{ "resource": "companies", "filters": [ { "field": "market_cap_in_usd", "operators": [ "gte", "lte" ], "type": "number", "unit": "USD", "options": null, "options_endpoint": null, "label": "Market Cap" }, { "field": "industry", "operators": [ "has_any" ], "type": "select", "unit": null, "options": [ { "id": "mining", "label": "Mining" }, { "id": "steel", "label": "Steel" } ], "options_endpoint": null, "label": "Industry" }, { "field": "commodities", "operators": [ "has_any", "has_only" ], "type": "select", "unit": null, "options": null, "options_endpoint": "/commodities/options/", "label": "Primary commodities" } ], "columns": [ { "key": "name", "title": "Company", "type": "string", "unit": null, "sortable": true }, { "key": "market_cap_in_usd", "title": "Market Cap", "type": "number", "unit": "USD", "sortable": true }, { "key": "cash_runway_months", "title": "Runway", "type": "number", "unit": "months", "sortable": true } ]}GETList commodities
Return the whole curated commodity registry in one response: each commodity's canonical quantity and grade units, the species contained metal is presented in (with the factor back to the commodity's canonical mass basis — the element, or TREO for rare earths — that the production and reserves datasets' `*_kg` fields and the dossier's `contained_canonical_kg` are in), which Pulse pipelines cover it, and its latest spot price with change over each window. Use it to interpret the commodity symbols every other endpoint returns. Not paginated — the registry is small and stable.
GETResolve options
Resolve a search term to a ranked list of id/label options for one of the platform's reference-data dropdowns (e.g. company or exchange lookups).