Transaction Stream Overview

​

Base URL

https://forecaster.cairhealth.com/api/stedi/2023-08-01

​

Authentication

1. Exchange your clientId / clientSecret for an access token at POST /api/token.
2. Send that token as a Bearer credential: Authorization: Bearer <accessToken>.
3. Your organization must have the api-access feature enabled. Tokens without it receive 401.

curl "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions?pageSize=1" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

​

Using a Stedi SDK

• Base URL / endpoint — set it to https://forecaster.cairhealth.com/api/stedi/2023-08-01.
• API key / Authorization value — set it to Bearer <your Cair access token> (the literal Bearer prefix is required).

// Point any Stedi Core 2023-08-01 client at Cair and pass the Cair token.
const stedi = Stedi({
  apiKey: `Bearer ${process.env.CAIR_ACCESS_TOKEN}`,
  baseUrl: 'https://forecaster.cairhealth.com/api/stedi/2023-08-01',
});

// Same calls as against Stedi:
for await (const transaction of stedi.core.listTransactions({ transactionSetId: '835' })) {
  console.log(transaction.transactionId, transaction.direction);
}

const x12 = await stedi.core.getTransactionInput('c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6');

​

What transactions are included

​

Pagination

• Stateless and encrypted — they encode a keyset position, not a database row id.
• Organization-bound — a token minted for one organization is rejected for another.
• Filter-bound (list only) — reusing a pageToken with a different filter set returns 400.

​

Errors

​

Compatibility notes

• partnershipId, sender, and receiver list filters are accepted for compatibility but ignored — all transactions use Cair’s shared Stedi connection.
• Only input and output artifacts are surfaced in artifacts[]; their url values point back at Cair’s download endpoints (see Get transaction input).
• The list and poll endpoints return the same TransactionSummary object, exactly as Stedi’s TransactionSummary schema defines it.

​

Endpoints