Home›Docs›API

REST API setup.

Use the REST API when your app or agent backend needs Australian data directly. Send the API key. Get JSON back. Start with PPSR and ABN checks.

Base https://api.assets.hoistai.com/v1Auth Authorization: Bearer ..PPSR + ABN first

Which interface should I use? Use the API for products and backend jobs. Use MCP when an AI client needs OAuth consent. Use the CLI for terminal checks and CI scripts. Compare all access paths.

Base URL

https://api.assets.hoistai.com/v1

The version is in the path. New optional fields may be added to v1. Breaking changes will use a new version.

Authentication

REST API and CLI API keys

Every API request except GET /v1/_health needs a Hoist Assets API key.

Authorization: Bearer $HOIST_ASSETS_API_KEY

For laypeople: treat this like a password. Keep it server-side. Do not paste it into client-side code, public repos, screenshots, or prompts.

The CLI can use the same API key with --token or HOIST_ASSETS_API_KEY. You do not create a separate CLI credential.

OAuth access tokens are also accepted for delegated clients, but new direct API and CLI setup should use Hoist Assets API keys.

MCP OAuth consent

MCP does not use HOIST_ASSETS_API_KEY. MCP gets a scoped access token through OAuth consent after a human approves the scopes an AI host is allowed to use.

Use the MCP issuer at https://mcp.assets.hoistai.com. Discovery lives at /.well-known/oauth-authorization-server, registration at /oauth/register, approval at /oauth/authorize, token exchange at /oauth/token, and disconnect at /oauth/revoke.

Available data

Dataset	Use it for	Typical question
PPSR	Organisation and serial-number checks.	Is there a registration against this business or asset?
ABN	Business identity and GST status checks.	Does this business have a valid ABN and GST registration?
Future sources	More Australian registers over time.	What else changed about this counterparty or asset?

Common endpoints

Endpoint	What it does	Auth
`GET /v1/_health`	Checks whether the API is responding.	None
`GET /v1/abn/{abn}`	Looks up an Australian Business Number.	Bearer token
`POST /v1/ppsr/preview`	Previews a PPSR search before a paid run.	Bearer token
`POST /v1/ppsr/search`	Runs a PPSR organisation or serial-number search.	Bearer token

ABN lookup

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

Use this when your agent needs to verify a business identity or GST status before it answers.

PPSR preview

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

Preview before running a paid PPSR search. Show the cost and subject back to the human before charging them.

PPSR search

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

Use this when your agent needs source data, not a guess. Paid searches require account access and billing capacity.

Responses

Responses are JSON. They include the source result, timestamps, IDs, and enough context for your agent to explain what it found.

Do not treat Hoist as legal, credit, tax, or financial advice. Hoist supplies Australian source data. Your product decides what to do with it.

OpenAPI

The OpenAPI spec is available as JSON and YAML.