List Company Tenements

Get tenements for a specific company

GET
/companies/{code}/tenements
AuthorizationBearer <token>

Bearer token authentication

In: header

Path Parameters

code*string

ASX code

Query Parameters

page?integer

Page number

Default1
Range1 <= value
per_page?integer

Results per page (max 100)

Default50
Range1 <= value <= 100
state?string

Filter by state

Value in"WA" | "NSW" | "QLD" | "VIC" | "SA" | "TAS" | "NT"
status?string

Filter by tenement status

Response Body

application/json

application/json

application/json

curl -X GET "https://api.canetoad.ai/api/v1/companies/string/tenements"
{
  "data": [
    {
      "id": "string",
      "tenement_id": "E45/1234",
      "state": "WA",
      "status": "granted",
      "type": "exploration",
      "holder_name": "string",
      "grant_date": "2019-08-24",
      "expiry_date": "2019-08-24",
      "area_km2": 0
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "per_page": 0,
    "total_pages": 0
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API token"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}