List Companies

Get a paginated list of ASX-listed resource companies

GET
/companies
AuthorizationBearer <token>

Bearer token authentication

In: header

Query Parameters

page?integer

Page number

Default1
Range1 <= value
per_page?integer

Results per page (max 100)

Default50
Range1 <= value <= 100
format?string

Output format

Default"json"
Value in"json" | "csv" | "tsv"
search?string

Search by company name or ASX code

sector?string

Filter by GICS sector

active?boolean

Filter by active status

Defaulttrue
sort?string

Sort field

Default"name"
Value in"name" | "market_cap" | "asx_code"
order?string

Sort order

Default"asc"
Value in"asc" | "desc"

Response Body

application/json

application/json

curl -X GET "https://api.canetoad.ai/api/v1/companies"
{
  "data": [
    {
      "asx_code": "BHP",
      "company_name": "BHP Group Limited",
      "market_cap_aud": 150000000000,
      "gics_sector": "Materials",
      "gics_industry_group": "Materials",
      "total_tenements": 250,
      "is_active": true
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "per_page": 0,
    "total_pages": 0
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API token"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded",
    "details": {
      "reset_at": 1706789460
    }
  }
}