1. Get access
Use Get API Access if you need a direct API key or paid source access. Once you have an API key, keep it server-side.
2. Choose your interface
| Interface | Best for | Auth |
|---|---|---|
| API | Products, backends, workflow engines, custom agents. | Authorization: Bearer $HOIST_ASSETS_API_KEY. |
| MCP | AI clients like Claude, ChatGPT, Cursor, Cline, Codex CLI, and Gemini CLI. | OAuth consent in the browser creates a scoped MCP token. |
| CLI | Terminal checks, scripts, CI jobs, and local debugging. | --token or HOIST_ASSETS_API_KEY. |
3. Run an ABN lookup
curl https://api.assets.hoistai.com/v1/abn/11695718659 \
-H "Authorization: Bearer $HOIST_ASSETS_API_KEY"
This is the simplest check. Your agent can use it to confirm business identity and GST status before answering.
4. Run a PPSR check
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"}'
PPSR searches can be billable. Preview or confirm the cost before letting an agent run one.
5. Connect an AI client with MCP
Use MCP when the agent is running inside a host that supports remote tools. Add this server URL:
https://mcp.assets.hoistai.com/mcp
The host opens a browser for OAuth consent. You approve the requested scopes. The host stores its own scoped access token and sends it with future MCP calls. Real PPSR/ABN source checks still require approved account access.
6. Use the CLI
npm install -g @hoist-assets/cli
export HOIST_ASSETS_API_KEY=<api_key>
hoist abn lookup 11695718659
hoist ppsr preview 123456789
hoist ppsr search 123456789
The CLI uses --token or HOIST_ASSETS_API_KEY. It uses the same API key as REST and does not need a separate CLI credential.
