# CivicIQ

> CivicIQ is the machine API for CivicNZ. It publishes New Zealand
> charities-register and GETS procurement data over HTTP. Browse and
> search routes are free. High-volume and officer-graph calls use
> x402 pay-per-call in Solana USDC.

Base URL: https://civiciq-api-production.up.railway.app
OpenAPI: https://civiciq-api-production.up.railway.app/openapi.json
Interactive docs: https://civiciq-api-production.up.railway.app/docs
x402 manifest: https://civiciq-api-production.up.railway.app/.well-known/x402

## Payment

- Protocol: x402 v1 (HTTP 402), scheme exact, network solana
- Asset: USDC on Solana (6 decimals)
- Client libraries: TypeScript `x402-fetch` / `@x402/fetch`, Python `x402`
- Unpaid calls return HTTP 402 with payment requirements in the body
  and a PAYMENT-REQUIRED header. Retry with X-PAYMENT.
- Receiving wallet (payTo): F3poQCw55uWQ41s4taZi5D8gHNvQWtLxJbSUMMZohBbT

## Paid endpoints

### GET /paid/tenders/search — $0.01 USDC

Search GETS procurement awards and open tenders.
Resource: https://civiciq-api-production.up.railway.app/paid/tenders/search
Query: search, department_id, supplier_id, tender_type, min_value, max_value, year, sort_by, limit, offset

### GET /paid/officers/{officer_id}/connections — $0.02 USDC

Board seats linked to an officer via the public charities register.
Resource: https://civiciq-api-production.up.railway.app/paid/officers/{officer_id}/connections
Path parameters: officer_id

### GET /paid/charities/{organisation_id} — $0.005 USDC

Charity profile using the same query as GET /charities/{id}.
Resource: https://civiciq-api-production.up.railway.app/paid/charities/{organisation_id}
Query: include_history
Path parameters: organisation_id

## Free endpoints

- GET https://civiciq-api-production.up.railway.app/health — liveness
- GET https://civiciq-api-production.up.railway.app/government/procurement/tenders — GETS tenders (limited)
- GET https://civiciq-api-production.up.railway.app/charities/ — charity search
- GET https://civiciq-api-production.up.railway.app/government/stats — government stats

## Attribution

Responses are provided by the CivicIQ team and include New Zealand
government source data reused under CC-BY 4.0. Attribute Charities
Services and GETS when you reuse the data.