POST /asx/v1/suggest

Suggest ASX-listed companies for a ticker or name prefix, at most ten.

Authentication: a short-lived signed token, Authorization: Bearer <token>. The audience is asx-lookup and the scope is asx.
Safe to repeat: yes. The client retries it after a retryable failure.
Agent tool: asx.suggest

POST/asx/v1/suggest

Request body

requiredapplication/json

modestring

live: ASX now; snapshot: the stored directory; live-first: ASX, then the snapshot on failure.

Allowed:livesnapshotlive-first

querystringrequired

A ticker or company name prefix.

max length 200

limitinteger

How many suggestions to return, 1 to 10.

min 1 · max 10

Responses

200

Success

Any of:

object

sourcestringrequired

Allowed:live

directoryObservedAtstringrequired

matches ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

suggestionsobject[]required

max items 10

Show properties

Array of object

tickerstringrequired

matches ^[A-Z0-9]{1,12}$

companyNamestringrequired

industryGroupstring | nullrequired

Show properties

Any of:

string

string

null

null

listingDatestring | nullrequired

Show properties

Any of:

string

string

null

null

marketCapitalisationnumber | string | nullrequired

Show properties

Any of:

number | string

Any of:

number

number

string

string

null

null

object

sourcestringrequired

Allowed:snapshot

generationstringrequired

matches ^[a-f0-9]{64}$

directoryObservedAtstringrequired

matches ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

requiresRecheckbooleanrequired

Allowed:true

suggestionsobject[]required

max items 10

Show properties

Array of object

tickerstringrequired

matches ^[A-Z0-9]{1,12}$

companyNamestringrequired

industryGroupstring | nullrequired

Show properties

Any of:

string

string

null

null

listingDatestring | nullrequired

Show properties

Any of:

string

string

null

null

marketCapitalisationnumber | string | nullrequired

Show properties

Any of:

number | string

Any of:

number

number

string

string

null

null

fallbackReasonstring

Allowed:INVALID_INPUTPARSE_FAILEDSOURCE_MISMATCHTRANSPORT_FAILEDTIMEOUTRATE_LIMITEDUPSTREAM_UNAVAILABLECONFIGURATION_ERRORSNAPSHOT_UNAVAILABLECANCELLEDINTERNAL_ERRORACCESS_DENIEDUPSTREAM_REJECTEDPERSISTENCE_FAILEDPUBLICATION_CONFLICTCOVERAGE_REJECTED

400

The body is not valid for this operation.

codestringrequired

Show properties

Any of:

string

string

messagestringrequired

retryablebooleanrequired

requestIdstringrequired

The request's id, for support.

401

The request carries no identified caller (ADR-0018).

codestringrequired

Show properties

Any of:

string

string

messagestringrequired

retryablebooleanrequired

requestIdstringrequired

The request's id, for support.

410

This major version is retired (ADR-0050).

codestringrequired

Show properties

Any of:

string

string

messagestringrequired

retryablebooleanrequired

requestIdstringrequired

The request's id, for support.

429

The fair-use ceiling is reached; retry after Retry-After.

codestringrequired

Show properties

Any of:

string

string

messagestringrequired

retryablebooleanrequired

requestIdstringrequired

The request's id, for support.

502

ASX answered, but its answer could not be used.

codestringrequired

Allowed:UPSTREAM_REJECTEDPARSE_FAILEDSOURCE_MISMATCH

messagestringrequired

retryablebooleanrequired

requestIdstringrequired

The request's id, for support.

503

The source is unavailable.

codestringrequired

Allowed:TRANSPORT_FAILEDRATE_LIMITEDUPSTREAM_UNAVAILABLEACCESS_DENIEDCONFIGURATION_ERRORSNAPSHOT_UNAVAILABLEPERSISTENCE_FAILED

messagestringrequired

retryablebooleanrequired

requestIdstringrequired

The request's id, for support.

504

The operation did not finish within its deadline.

codestringrequired

Show properties

Any of:

string

string

messagestringrequired

retryablebooleanrequired

requestIdstringrequired

The request's id, for support.

Request

curl -sS -X POST https://api.comms.id/asx/v1/suggest \
  -H "Authorization: Bearer $COMMS_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query":"BH","limit":5}' \
  -H "Accept: application/json"

import { createAsxClient } from "@comms-id/asx/server";

const client = createAsxClient({
  clientId: process.env.COMMS_ID_CLIENT_ID!,
  privateJwk: JSON.parse(process.env.COMMS_ID_PRIVATE_JWK!),
});
const reply = await client.suggest({
  query: "BH",
  limit: 5
});

npx comms-id asx suggest --query "BH" --limit 5

Response

{
  "source": "live",
  "directoryObservedAt": "2026-10-03T00:00:00.000Z",
  "suggestions": []
}

{
  "code": "INVALID_INPUT",
  "message": "string",
  "retryable": true,
  "requestId": "string"
}

{
  "code": "UNAUTHORIZED",
  "message": "string",
  "retryable": true,
  "requestId": "string"
}

{
  "code": "VERSION_RETIRED",
  "message": "string",
  "retryable": true,
  "requestId": "string"
}

{
  "code": "FAIR_USE_CEILING",
  "message": "string",
  "retryable": true,
  "requestId": "string"
}

{
  "code": "UPSTREAM_REJECTED",
  "message": "string",
  "retryable": true,
  "requestId": "string"
}

{
  "code": "TRANSPORT_FAILED",
  "message": "string",
  "retryable": true,
  "requestId": "string"
}

{
  "code": "TIMEOUT",
  "message": "string",
  "retryable": true,
  "requestId": "string"
}