Transactions API¶

Base path: /core/api/communities/{community_id}/sessions/transactions

Transactions represent the actual energy exchanges between community members after market clearing.

Get Transactions¶

GET /core/api/communities/{community_id}/sessions/transactions
  ?start_datetime=2024-01-15T00:00:00
  &end_datetime=2024-01-15T23:59:59
  &granularity=HOURLY

Get Transaction Adjustments¶

Adjustments correct small discrepancies (within transaction_adjustment_tolerance) between metered and computed energy values.

GET /core/api/communities/{community_id}/sessions/transactions/adjustments
  ?start_datetime=2024-01-15T00:00:00
  &end_datetime=2024-01-15T23:59:59

Create Transaction Adjustment¶

curl -X POST \
  https://<host>/core/api/communities/{community_id}/sessions/transactions/adjustments \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "member_id": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
    "adjustment_kwh": 0.005,
    "reason": "Tolerance correction"
  }'