Ghaem Gold API
rev 51ce12b9664f

Ghaem Gold API

19 APIs · 107 operations · always current, straight from the specs.

Assets API

The asset registry: what a balance line can be denominated in — Rial, gold and silver weights, individual coin variants, bullion, and foreign currenc…

3 operations v1.0.0

Audit Log API

«مشاهده لاگ‌ها» — the append-only, tamper-evident record of everything that happened in the system, and the tool that proves it has not been altered.…

4 operations v1.0.0

Admin Audit Log API

Exporting the audit trail — a single endpoint, and the most tightly gated read in the whole API. Browsing the trail, reading one row, listing the act…

1 operations v1.0.0

Authentication API

Operator sign-in, refresh-token rotation and session management for the Ghaem Gold panel. §4.1 — the only population that signs in is the operator (p…

6 operations v1.0.0

Bank Accounts API

Counterparty bank accounts — the destinations settlement money is actually sent to — plus the read-only bank catalog they are classified against. An …

9 operations v1.0.0

Admin Bank Accounts API

The three flags on a bank account that govern how the settlement matching engine treats it: whether the account is excluded from matching altogether,…

3 operations v1.0.0

Files API

Retrieval of stored receipt images. Two routes, with deliberately different security models. Files in this system live in private object storage. Not…

2 operations v1.0.0

Financial Records API

«سوابق مالی» — multi-asset counterparty balances mirrored from the accounting system: the current book, one record's full snapshot history with per-a…

4 operations v1.0.0

Health and Metrics API

Operational endpoints: two orchestrator probes and one Prometheus scrape target. None of them requires authentication, and none of them is part of th…

3 operations v1.0.0

Ingestion API

«همگام‌سازی» — the pipeline that pulls parties and balances from the external accounting system, and the operator surface for watching it. Three idea…

7 operations v1.0.0

Admin Ingestion API

The three ingestion operations that change canonical data by re-deriving it from stored vendor payloads: resolving a quarantine row, reprocessing a s…

3 operations v1.0.0

Matching API

«لیست تطبیق» — the settlement allocation engine. It decides which debtor pays which creditor, into which nominated bank account, for how much. This i…

15 operations v1.0.0

Admin Matching API

The three decisions in the settlement matching engine that have money attached: freezing a plan, issuing payment orders from it, and changing the eng…

4 operations v1.0.0

Admin Operators API

Management of operators — the panel staff who sign in and hold permissions. §4.1 — this is not the counterparty list: a party is an external entity m…

8 operations v1.0.0

Parties API

The counterparty list — «لیست کاربران» in the panel sidebar. A party is an external entity mirrored from the accounting system: it never signs in, ho…

8 operations v1.0.0

Admin Parties API

Administrator-only control over whether a counterparty takes part in settlement matching at all. Everything else about a party — searching, reading, …

2 operations v1.0.0

Party Groups API

Counterparty groups — صندوق / ويترين داران / خانگي and anything the sync has met since. A party group classifies an external counterparty; it confers…

5 operations v1.0.0

Payments API

«سوابق پرداخت» — payment orders, the state machine they move through, and the receipt (فیش) evidence attached to them. Payments here are recorded, no…

13 operations v1.0.0

Admin Roles and Permissions API

The panel's access-control settings: the panel roles operators are assigned to, and the read-only permission catalog those roles are built from. §4.1…

7 operations v1.0.0

Connect an AI agent

Point an agent here once and it always reads current docs — nothing to re-share.

{
  "mcpServers": {
    "apiwarden": { "type": "http", "url": "<origin>/mcp" }
  }
}

Or fetch it as plain data: