Search companies

Screen companies by a curated set of filterable fields — commodities, geography, exchange listings, market cap, and more. Returns matching companies with the requested columns, or a default column set if none are requested. An empty filter list enumerates active companies across every industry; pass an `industry` filter to narrow to mining.

POST/v1/companies/search/

Authorization

apiKeyAuth

AuthorizationBearer <token>

Organization API key, format pulse_<prefix>_<secret>. Created by an organization admin in Settings -> API Keys.

In: header

Request Body

application/json

Filter-based search request. Combine filter clauses with logic, choose response columns with columns, and page through matches with limit/offset/sort. Send an empty (or omitted) filters list to enumerate the resource.

filters?array<>

Filter clauses to apply. The available fields and operators are listed in the filter & column reference, or live via GET /v1/filters/{resource}/.

logic?string

How to combine filters: all (every clause must match), any (at least one must match), or custom (combine per expression). Defaults to all.

Value in

"all"
"any"
"custom"

expression?|

Boolean expression over 1-based filter positions, e.g. 1 AND (2 OR 3). Required when logic is custom; ignored otherwise.

columns?|

Comma-separated column keys to include in results, e.g. name,market_cap_in_usd. Defaults to the resource's default column set; valid keys are listed in the filter & column reference, or live via GET /v1/filters/{resource}/.

limit?|

Rows per page, 1-100. Defaults to 25; out-of-range values are clamped rather than rejected.

offset?|

Number of rows to skip, for paging through count. Defaults to 0. Pair with sort — without one, ordering falls back to the resource default and paging is only as stable as that.

sort?|

Column key to sort by, prefixed with - for descending (e.g. -market_cap_in_usd). Must be a sortable key from the same vocabulary as columns. Results always carry an internal id tiebreaker, so paging with a sort is deterministic.

Response Body

Matching companies.

Matching rows in results (one object per row, keyed by column), with the total match count, whether more rows remain, and the page that was served.

results*array<>

Matching rows, one object per row, keyed by column key — the resource's default column set, or the columns you requested. Every key and its type is listed in the filter & column reference.

count*integer

Total number of matching rows, including any beyond the returned page.

truncated*boolean

true when more rows matched than this page returns — advance offset by limit to fetch the rest. Equivalent to count > offset + len(results).

limit*integer

Page size actually used, echoing the request's limit after clamping to 1-100. Defaults to 25.

offset*integer

Number of rows skipped, echoing the request's offset. Defaults to 0.

curl -X POST "https://example.com/v1/companies/search/" \  -H "Authorization: Bearer $PULSE_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "filters": [      {        "field": "commodities",        "operator": "has_any",        "value": [          1        ]      },      {        "field": "market_cap_in_usd",        "operator": "gte",        "value": 1000000000      }    ],    "logic": "all",    "columns": "name,market_cap_in_usd,commodities,hq_country"  }'

{  "results": [    {      "id": 5700,      "name": "AbraSilver Resource Corp",      "market_cap_in_usd": 1699677234,      "commodities": [        "Cu",        "Ag"      ],      "hq_country": "Canada"    }  ],  "count": 128,  "truncated": true,  "limit": 25,  "offset": 0}