Quickstart

Add Australian register data to your app, script, or AI workflow. Start with ABN lookup, then use PPSR preview and search when the account has approved source access.

1. Get access

Use a Hoist API key (prefixed ha_live_) for REST API and CLI calls. MCP hosts get a scoped token through OAuth consent — no key to paste.

export HOIST_API_KEY=ha_live_xxxxxxxxxxxxxxxxxxxxxxxx

2. Choose the interface

Interface	Best fit	Start here
REST API	Products, backend jobs, workflow automation	REST API
CLI	Terminal checks, CI, local agents	CLI
MCP	AI hosts that need user-approved tool access	MCP

3. Run an ABN lookup

curl https://api.assets.hoistai.com/v1/abn/11695718659 \
  -H "Authorization: Bearer $HOIST_API_KEY"

Use ABN lookup when an agent needs to verify business identity or GST status before answering.

4. Preview a PPSR search

curl https://api.assets.hoistai.com/v1/ppsr/preview \
  -H "Authorization: Bearer $HOIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject_kind":"organisation","acn":"123456789"}'

Preview flows are designed for confirmation. Show the subject and cost back to the human before a paid dispatch.

5. Connect an AI client

Use the MCP endpoint in your AI host:

MCPhttps://mcp.assets.hoistai.com/mcp

Then approve the scopes in the browser window the host opens.

6. Use the CLI

hoist health --base-url https://api.assets.hoistai.com
hoist abn lookup 11695718659 --json
hoist ppsr preview 123456789 --json

The CLI uses the same API key as the REST API with --token or HOIST_API_KEY.