API Reference¶
RTOpacks provides a public REST API for querying the National Register.
Base URL: https://api.rtopacks.com.au
Authentication: None required. Public access.
Format: All responses are JSON.
Endpoints¶
GET /¶
API index. Returns server info, version, and endpoint list.
GET /v1/search¶
Search the National Register.
Parameters:
q(required) — keyword or partial codetype(optional) —qualification,unit,skillset,rto,all(default:all)limit(optional) — max results, default 10, max 50include_archived(optional) — include superseded records, defaultfalse
Example:
GET https://api.rtopacks.com.au/v1/search?q=workplace+safety&type=unit
GET /v1/lookup/:code¶
Get full record detail by National Register code.
Example:
GET https://api.rtopacks.com.au/v1/lookup/BSBWHS411
GET /v1/ladder/:package_code¶
Get the AQF qualification ladder for a training package.
Example:
GET https://api.rtopacks.com.au/v1/ladder/BSB
GET /v1/verify/:sop_id¶
Verify a RTOpacks Statement of Provenance ID. (Coming soon)
GET /v1/health¶
Health check.
Rate Limits¶
No rate limits currently applied. Fair use expected.
Authentication¶
No authentication required for public endpoints. API key system coming in a future release.