Pulse IntelligenceAPI Docs

Data Reference

Every metric Pulse tracks, organized by module — what it means, where it comes from, and where you can reach it.

The data reference is a complete field-level catalog of what Pulse tracks across companies, mining assets, production, reserves, drilling, economic studies, ownership, deals, people, documents, mineral tenure, and financial health. Each page below covers one module, grouped the way the underlying data is grouped, so you can find a field by the same mental model you'd use to browse the product.

This is a reference for understanding the shape and meaning of Pulse's data model — not an endpoint list. For the public API surface itself, see the API reference and the filters and options guide.

Reading a metric row

Each table row describes one field:

ColumnMeaning
MetricThe field name. A parenthetical after the name, when present, gives the scope and granularity the value is reported at (for example, Company · Per listing).
DescriptionWhat the field means. An Example line shows a representative value; an Options line lists the closed set of values for enum-like fields.
TypeThe field's data type — string, enum, number, integer, boolean, date, datetime, geo, link, text, or a compound like integer + enum.
UnitThe unit the value is reported in, where applicable (currency, percentage, tonnes, and so on). Blank means the field is unitless.
AvailabilityWhere you can reach the field — see the vocabulary below.

Availability vocabulary

  • API (v1) — exposed on a public /v1/ API response (search, filter, or dossier endpoint).
  • MCP — returned by one of Pulse's curated MCP tools (search_companies, search_mining_assets, search_publications, search_people, get_company_dossier, get_asset_dossier, describe_filters, resolve_options, portfolio tools). This does not include the raw-SQL tools (run_read_query and friends) — those can reach virtually any field in the database, so counting them would make this tag meaningless.
  • UI column — a sortable/visible column in a Pulse screener table.
  • UI filter — usable as a search/screener filter.
  • UI sort — usable as a sort key.
  • UI search — reachable via free-text search.
  • UI detail — shown on a detail/dossier page rather than a table.
  • UI map — shown on a map view.
  • UI tab, UI tree — shown in a dedicated tab or hierarchical view.
  • UI label, UI (display label), UI (basis label) — used as display copy (a badge, header, or basis annotation) rather than a queryable value.

A field can carry more than one of these at once (for example, UI column · UI filter · UI sort · API (v1) · MCP). API (v1) and MCP are independent — a field can be public-API-reachable without being MCP-reachable, or vice versa, since the two surfaces expose different curated slices of the same underlying data.

Modules

Keeping this current

These pages are generated from the Pulse Metrics Catalog, dated 2026-08-04, committed at data/metrics-catalog.json. This index page is hand-written and is never regenerated. To refresh the catalog and pages, see the regeneration runbook in scripts/README.md.

On this page