Docs Getting Started Quickstart

Quickstart

Make your first API call in under 5 minutes.

Prerequisites

  • An API key (ak_...) and secret (sk_...) — see Authentication to request access
  • Any HTTP client: curl, Postman, or your programming language’s HTTP library

1. Check the API is reachable

curl https://api.awardsintelligence.com.au/api/v1/health
{
  "status": "ok",
  "version": "1.0.0",
  "timestamp": "2026-03-14T10:00:00Z",
  "awards_loaded": 11
}

The health endpoint does not require authentication.

2. Calculate pay for a shift

Calculate minimum pay for a full-time Hospitality Level 1 employee working a standard weekday shift:

curl -X POST https://api.awardsintelligence.com.au/api/v1/calculate-pay \
  -H "Authorization: Bearer ak_YOUR_KEY_ID:sk_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "award_code": "MA000009",
    "classification_code": "HI1",
    "employment_type": "full_time",
    "work_date": "2026-03-16",
    "start_time": "09:00",
    "end_time": "17:00",
    "unpaid_break_minutes": 30
  }'
{
  "award_code": "MA000009",
  "classification_code": "HI1",
  "employment_type": "full_time",
  "work_date": "2026-03-16",
  "day_of_week": "Monday",
  "is_public_holiday": false,
  "gross_pay": 189.70,
  "ordinary_earnings": 189.70,
  "overtime_earnings": 0.0,
  "penalty_earnings": 0.0,
  "allowance_total": 0.0,
  "rate_derivation": {
    "weekly_rate": 973.90,
    "ordinary_hours_per_week": 38.0,
    "base_hourly_rate": 25.6289,
    "effective_hourly_rate": 25.6289,
    "derivation_formula": "973.90 / 38.0 = $25.6289/hr"
  },
  "hours_breakdown": {
    "total_worked_hours": 7.5,
    "ordinary_hours": 7.5,
    "overtime_hours_150": 0.0,
    "overtime_hours_200": 0.0
  },
  "pay_components": [
    {
      "component_type": "ordinary",
      "description": "Ordinary hours",
      "hours": 7.5,
      "rate": 25.6289,
      "multiplier": 1.0,
      "amount": 192.22
    }
  ]
}

3. Check for compliance risks

Run a pre-calculation compliance risk check on the same input:

curl -X POST https://api.awardsintelligence.com.au/api/v1/detect-risks \
  -H "Authorization: Bearer ak_YOUR_KEY_ID:sk_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "award_code": "MA000009",
    "classification_code": "HI1",
    "employment_type": "full_time",
    "work_date": "2026-03-16",
    "start_time": "09:00",
    "end_time": "17:00",
    "unpaid_break_minutes": 30
  }'

The response includes detected risks, severity levels, and review actions.

4. List available awards

curl https://api.awardsintelligence.com.au/api/v1/awards \
  -H "Authorization: Bearer ak_YOUR_KEY_ID:sk_YOUR_SECRET"

Returns all 122 Modern Awards with metadata indicating which support deterministic calculations.

Next steps