Filter & column reference
Every filterable field and response column the public API accepts, per resource.
The complete filter and column vocabulary the search endpoints accept —
the same data GET /v1/filters/{resource}/ returns. select-type
filters take option ids. Closed vocabularies are carried inline; resolve
request-backed labels through the listed endpoint (see Resolving option values).
How filters combine (logic, expression) and how columns shapes the
response is covered in Filters & search.
Companies
Search with POST /v1/companies/search/; fetch this vocabulary live with GET /v1/filters/companies/.
Filterable fields
| Field | Label | Type | Unit | Operators | Options endpoint |
|---|---|---|---|---|---|
market_cap_in_usd | Market Cap | number | USD | gte lte | — |
total_cash_in_usd | Cash in Bank | number | USD | gte lte | — |
cash_runway_months | Cash Runway | number | months | gte lte | — |
exchanges | Exchanges | select | — | has_any has_only | /v1/options/exchanges/options/ |
industry | Industry | select | — | has_any | Inline (3) |
ownership_type | Ownership | select | — | has_any | Inline (3) |
commodities | Primary commodities | select | — | has_any has_only | /v1/options/commodities/options/ |
by_products | By-products | select | — | has_any | /v1/options/commodities/options/ |
all_commodities | All commodities | select | — | has_any has_only | /v1/options/commodities/options/ |
asset_world_regions | World regions | select | — | has_any has_only | /v1/options/world-regions/options/ |
asset_countries | Countries | select | — | has_any has_only | /v1/options/countries/options/ |
asset_provinces | Provinces / states | select | — | has_any has_only | /v1/options/provinces/options/ |
asset_phases | Phases | select | — | has_any has_only | Inline (4) |
asset_stages | Stages | select | — | has_any has_only | Inline (10) |
asset_milestones | Asset milestones | select | — | has_any | Inline (10) |
asset_permits | Asset permits | select | — | has_any | Inline (6) |
change_1d | 1D Change | number | % | gte lte | — |
change_1w | 1W Change | number | % | gte lte | — |
change_1m | 1M Change | number | % | gte lte | — |
change_3m | 3M Change | number | % | gte lte | — |
change_6m | 6M Change | number | % | gte lte | — |
change_1y | 1Y Change | number | % | gte lte | — |
change_2y | 2Y Change | number | % | gte lte | — |
change_3y | 3Y Change | number | % | gte lte | — |
change_4y | 4Y Change | number | % | gte lte | — |
change_5y | 5Y Change | number | % | gte lte | — |
change_ytd | YTD Change | number | % | gte lte | — |
stock_price_date | Price Date | date | — | gte lte | — |
updated_at | Record Updated | date | — | gte lte | — |
data_refreshed_at | Data Refreshed | date | — | gte lte | — |
enterprise_value_in_usd | Enterprise Value | number | USD | gte lte | — |
ebitda_in_usd | EBITDA | number | USD | gte lte | — |
net_debt_in_usd | Net Debt | number | USD | gte lte | — |
shares_outstanding | Shares Outstanding | number | — | gte lte | — |
company | Companies | select | — | has_any | /v1/options/companies/options/ |
Response columns
| Column key | Title | Type | Sortable |
|---|---|---|---|
name | Company | string | Yes |
market_cap_in_usd | Market Cap | number | Yes |
total_cash_in_usd | Cash in Bank | number | Yes |
cash_runway_months | Runway (months) | number | Yes |
hq_country | HQ | string | No |
website | Website | string | No |
exchanges | Exchanges | string | No |
industry | Industry | string | No |
ownership_type | Ownership | string | No |
commodities | Primary Commodities | string | No |
by_products | By-products | string | No |
all_commodities | All Commodities | string | No |
asset_world_regions | Asset World Regions | string | No |
asset_countries | Asset Countries | string | No |
asset_provinces | Asset Provinces | string | No |
asset_phases | Asset Phases | string | No |
asset_stages | Asset Stages | string | No |
asset_milestones | Asset Milestones | string | No |
asset_permits | Asset Permits | string | No |
stock_price | Stock Price | number | Yes |
change_1d | 1D Change | number | Yes |
change_1w | 1W Change | number | Yes |
change_1m | 1M Change | number | Yes |
change_3m | 3M Change | number | Yes |
change_6m | 6M Change | number | Yes |
change_1y | 1Y Change | number | Yes |
change_2y | 2Y Change | number | Yes |
change_3y | 3Y Change | number | Yes |
change_4y | 4Y Change | number | Yes |
change_5y | 5Y Change | number | Yes |
symbol | Symbol | string | No |
currency_symbol | Currency | string | No |
stock_price_currency_symbol | Stock Price Currency | string | No |
stock_price_ticker | Stock Price Listing | string | No |
change_ytd | YTD Change | number | Yes |
price_sync_date | Price Sync Date | datetime | Yes |
stock_price_date | Price Date | date | Yes |
updated_at | Record Updated | datetime | Yes |
data_refreshed_at | Data Refreshed | datetime | Yes |
enterprise_value_in_usd | Enterprise Value | number | Yes |
ebitda_in_usd | EBITDA | number | Yes |
net_debt_in_usd | Net Debt | number | Yes |
shares_outstanding | Shares Outstanding | number | Yes |
company | Companies | string | No |
Mining assets
Search with POST /v1/mining-assets/search/; fetch this vocabulary live with GET /v1/filters/mining-assets/.
Filterable fields
| Field | Label | Type | Unit | Operators | Options endpoint |
|---|---|---|---|---|---|
primary_commodity | Primary commodities | select | — | has_any | /v1/options/commodities/options/ |
commodities | All commodities | select | — | has_any has_only | /v1/options/commodities/options/ |
by_products | By-products | select | — | has_any | /v1/options/commodities/options/ |
world_regions | World regions | select | — | has_any | /v1/options/world-regions/options/ |
country | Countries | select | — | has_any | /v1/options/countries/options/ |
phase | Phase | select | — | has_any | Inline (4) |
stage | Stage | select | — | has_any | Inline (10) |
activity_status | Activity Status | select | — | has_any | Inline (5) |
milestones_reached | Milestones reached | select | — | has_any | Inline (10) |
granted_permits | Permits granted | select | — | has_any | Inline (6) |
asset_type | Asset Type | select | — | has_any | Inline (2) |
mine_type | Mine Type | select | — | has_any | Inline (6) |
deposit_type | Deposit Type | select | — | has_any | Inline (31) |
province | Provinces / states | select | — | has_any | /v1/options/provinces/options/ |
primary_company_market_cap_in_usd | Company Market Cap | number | USD | gte lte | — |
exchanges | Company exchanges | select | — | has_any has_only | /v1/options/exchanges/options/ |
primary_company_change_1d | 1D Change | number | % | gte lte | — |
primary_company_change_1w | 1W Change | number | % | gte lte | — |
primary_company_change_1m | 1M Change | number | % | gte lte | — |
primary_company_change_3m | 3M Change | number | % | gte lte | — |
primary_company_change_6m | 6M Change | number | % | gte lte | — |
primary_company_change_1y | 1Y Change | number | % | gte lte | — |
primary_company_change_2y | 2Y Change | number | % | gte lte | — |
primary_company_change_3y | 3Y Change | number | % | gte lte | — |
primary_company_change_4y | 4Y Change | number | % | gte lte | — |
primary_company_change_5y | 5Y Change | number | % | gte lte | — |
primary_company_change_ytd | YTD Change | number | % | gte lte | — |
facility_type | Facility Type | select | — | has_any | Inline (6) |
latest_economic_assessment_effective_date | Study Date | date | — | gte lte | — |
latest_economic_assessment_npv_usd | Study NPV (post-tax, USD) | number | USD | gte lte | — |
latest_economic_assessment_discount_rate | Study NPV Discount Rate | number | % | gte lte | — |
latest_economic_assessment_irr | Study IRR (post-tax) | number | % | gte lte | — |
latest_economic_assessment_capex_usd | Study Initial CapEx (USD) | number | USD | gte lte | — |
latest_drill_results_date | Latest Drill Results Date | date | — | gte lte | — |
drillhole_count | Drillhole Count | number | — | gte lte | — |
best_interval_value | Best Drill Interval Value ($·m/t) | number | $·m/t | gte lte | — |
updated_at | Record Updated | date | — | gte lte | — |
data_refreshed_at | Data Refreshed | date | — | gte lte | — |
mining_asset | Mining Assets | select | — | has_any | /v1/options/mining-assets/options/ |
company | Companies | select | — | has_any | /v1/options/companies/options/ |
Response columns
| Column key | Title | Type | Sortable |
|---|---|---|---|
name | Mining Asset | string | Yes |
primary_commodity | Primary Commodity | string | No |
commodities | All Commodities | string | No |
by_products | By-products | string | No |
world_regions | World Regions | string | No |
country | Country | string | No |
phase | Phase | string | Yes |
stage | Stage | string | Yes |
activity_status | Activity Status | string | Yes |
milestones_reached | Milestones | string | No |
granted_permits | Permits | string | No |
asset_type | Asset Type | string | Yes |
mine_type | Mine Type | string | Yes |
deposit_type | Deposit Type | string | Yes |
province | Province/State | string | No |
location | Location | string | No |
latitude | Latitude | number | Yes |
longitude | Longitude | number | Yes |
primary_company_name | Primary Company | string | No |
primary_company_market_cap_in_usd | Market Cap | number | Yes |
exchanges | Exchanges | string | No |
primary_company_change_1d | 1D Change | number | Yes |
primary_company_change_1w | 1W Change | number | Yes |
primary_company_change_1m | 1M Change | number | Yes |
primary_company_change_3m | 3M Change | number | Yes |
primary_company_change_6m | 6M Change | number | Yes |
primary_company_change_1y | 1Y Change | number | Yes |
primary_company_change_2y | 2Y Change | number | Yes |
primary_company_change_3y | 3Y Change | number | Yes |
primary_company_change_4y | 4Y Change | number | Yes |
primary_company_change_5y | 5Y Change | number | Yes |
primary_company_change_ytd | YTD Change | number | Yes |
primary_company_price_sync_date | Price Sync Date | datetime | Yes |
mining_method | Mining Method | string | No |
processing_method | Processing Method | string | No |
facility_type | Facility Type | string | Yes |
latest_economic_assessment_effective_date | Study Date | date | Yes |
latest_economic_assessment_study_type | Study Type | string | Yes |
latest_economic_assessment_npv_usd | Study NPV Post-tax | number | Yes |
latest_economic_assessment_discount_rate | NPV Discount | number | No |
latest_economic_assessment_irr | Study IRR Post-tax | number | Yes |
latest_economic_assessment_capex_usd | Study Initial CapEx | number | Yes |
npv_to_capex | NPV / CapEx | number | Yes |
latest_economic_assessment_mine_life_years | Mine Life | number | No |
latest_drill_results_date | Latest Drill Results Date | datetime | Yes |
drillhole_count | Drillholes | number | Yes |
best_interval_value | Best Interval Value ($·m/t) | string | Yes |
updated_at | Record Updated | datetime | Yes |
data_refreshed_at | Data Refreshed | datetime | Yes |
mining_asset | Mining Assets | string | No |
company | Companies | string | No |