Docs
On this page
Docs/AVM/Developer Resources

Resources · AVM

Developer Resources

Start with an offline example, then connect to the APIs enabled for your account. These downloads are small evaluation tools, not a full SDK or a substitute for the API reference.

Downloads

ResourceWhat It Contains
Node.js starter clientA dependency-free command-line client for release discovery, catalogues, basic series queries and an explicitly confirmed single valuation.
Postman collectionSix discovery requests and two example series requests. No valuation submissions.
Discovery OpenAPI documentA machine-readable subset covering six GET discovery routes. Not the complete valuation or Data Bank schema.
Existing request examplesAn illustrative property request. Replace the identity, characteristics and date; do not submit example addresses as real properties.

Try It Without An Account

Save the Node.js file locally. Use Node.js 22 or newer:

bash
node valtaic-starter.mjs fixture

This mode makes no network requests and requires no key. It returns a synthetic valuation excerpt and demonstrates how to distinguish a valued result from a referral, rejection or failure. It is not an accuracy test or a hosted sandbox.

Connect Your Account

Request access through hello@valtaic.io. Agree the enabled products, credentials, quotas, environment and any evaluation charges before sending requests. A test-key prefix alone does not establish that a separate free sandbox is available.

Set VALTAIC_API_KEY in your local environment or secret manager. Do not paste a live key into this website, a shared collection, browser code or source control. VALTAIC_BASE_URL defaults to https://api.valtaic.io; change it only to a verified HTTPS origin supplied for your environment.

bash
node valtaic-starter.mjs release --live
node valtaic-starter.mjs datasets --family markets --live
node valtaic-starter.mjs areas --live

The --live flag is required for every network operation. Catalogue and series access depends on your account entitlements; AVM access does not automatically include Data Bank.

Retrieve A Market Series

After checking your catalogue and area list:

bash
node valtaic-starter.mjs series --family markets \
  --dataset market_activity --area E08000025 \
  --property-type flat --metrics sales_count --live

The area is an example identifier, not a coverage guarantee. No dates means the latest available observation. Add --from YYYY-MM --to YYYY-MM for a monthly period. Keep units, observation dates, availability and release references with the result. Missing values are not zero.

bash
node valtaic-starter.mjs series --family rates --dataset bank_rate --live

This starter supports a small selector set and does not automatically follow pagination. Use the Data Bank integration guide for other products, selectors and complete result retrieval.

Submit A Valuation Deliberately

Prepare your own request.json using the Request Schema. Discover the active valuation-date window before selecting a date. Enable stored property data only where you intend to and your scope permits it.

bash
node valtaic-starter.mjs value --file request.json --live --confirm-usage

This submits one request and may consume valuation units or incur charges under your agreement. The additional confirmation flag prevents accidental submissions. No request is retried automatically, including after a timeout. A successful HTTP response is not enough: inspect the individual result status before using an estimate.

Import Into Postman

Import the collection file. Store apiKey in a private, local environment or your organisation's approved secret facility; leave the distributed collection's empty key unchanged. Confirm the base URL and account access before clicking Send. Do not publish, share or export an environment containing a live key.

The collection includes only GET requests. These are not necessarily free and may consume request quota. It deliberately excludes valuation POSTs and bulk jobs.

Before Production

The starter is intentionally small: no automatic retries, batching, job polling, caching or full schema validation. It uses a bounded timeout, refuses redirects and avoids printing raw error bodies or authentication headers. Successful output can contain property data; protect any saved results.

Follow the Integration Guide, Authentication, Errors & Retries and Versioning & Releases. Test accepted and non-valued cases against the service agreed for your pilot before relying on results.