API Reference
In total: 3 services, 31 entities, 37 actions
All entity sets support $filter, $select, $expand, $top, $skip, $count, $orderby
All actions are POST with JSON body
All services gated by @requires: 'authenticated-user'
| Service | Path |
|---|---|
CardanoODataService | /odata/v4/cardano-odata/ |
CardanoTransactionService | /odata/v4/cardano-transaction/ |
CardanoSignService | /odata/v4/cardano-sign/ |
CardanoODataService /odata/v4/cardano-odata/
Read-only blockchain queries via lazy on-demand indexing with TTL refresh.
Entities
NetworkInformation · Blocks · Epochs · Pools · Dreps · Transactions · TransactionInputs · TransactionOutputs · TransactionInputAssets · TransactionOutputAssets · Accounts · Addresses · AddressAssets · AddressUTxOs · AddressTransactions · UTxOAssets · TransactionMetadata · LedgerProtocolParameters
Actions
| Action | Params | Returns |
|---|---|---|
GetNetworkInformation | - | NetworkInformation |
GetBlockByHash | hash: Blake2b256 | Blocks |
GetEpochByNumber | epochNumber: Integer | Epochs |
GetPoolById | poolId: String | Pools |
GetDrepById | drepId: String | Dreps |
GetAccountByStakeAddress | stakeAddress: Bech32 | Accounts |
GetTransactionByHash | hash: Blake2b256 | Transactions |
GetMetadataByTxHash | tx_hash: Blake2b256 | TransactionMetadata[] |
GetAddressByBech32 | address: Bech32 | Addresses |
GetUTxOsByAddress | address: Bech32 | AddressUTxOs[] |
GetAssetsByAddress | address: Bech32 | AddressAssets[] |
GetLatestTransactionsByAddress | address: Bech32, limit: Integer | AddressTransactions[] |
GetLatestBlock | - | Blocks |
GetLatestEpoch | - | Epochs |
GetLedgerProtocolParameters | - | LedgerProtocolParameters |
ParseTransactionCbor | cbor: LargeString (≤ 128 KiB hex) | ParsedTransaction (pure, no network/DB) |
CardanoTransactionService /odata/v4/cardano-transaction/
Build, track, submit. Two builders: csl, buildooor.
Entities
TransactionBuilds · TransactionBuildInputs · TransactionBuildOutputs · TransactionBuildInputAssets · TransactionBuildOutputAssets · TransactionSubmissions · TransactionSubmissionErrors · AddressTransactionBuilds
Actions
BuildSimpleAdaTransaction · BuildTransactionWithMetadata · BuildMultiAssetTransaction · BuildMintTransaction · BuildPlutusSpendTransaction · SetCollateral
Lookup:
| Action | Params | Returns |
|---|---|---|
GetBuildDetails | buildId: UUID | TransactionBuilds |
GetTransactionBuildsByAddress | address: Bech32 | AddressTransactionBuilds[] |
Submit:
| Action | Params | Returns |
|---|---|---|
SubmitTransaction | buildId: UUID, signedTxCbor: String | TransactionSubmissions |
SubmitSignedTransaction | signedTxCbor: String, network: String(10) | TransactionSubmissions |
CheckSubmissionStatus (bound on TransactionSubmissions(id)) | - | TransactionSubmissions |
Utilities (v1.7.5):
| Action | Params | Returns |
|---|---|---|
DeriveScriptAddress | validatorScript, scriptParamsJson?, network? | { scriptAddress, scriptHash } |
ExtractPaymentKeyHash | address: Bech32 | { paymentKeyHash } |
Full Build-action parameter tables: Transaction Workflow.
CardanoSignService /odata/v4/cardano-sign/
Entities
SigningRequests · SignatureVerifications · AddressSigningRequests · TransactionBuilds · TransactionSubmissions
Actions
Workflow:
| Action | Params | Returns |
|---|---|---|
CreateSigningRequest | buildId: UUID, message: String | SigningRequests |
GetSigningRequest | signingRequestId: UUID | SigningRequests |
GetSigningRequestsByAddress | address: Bech32 | AddressSigningRequests[] |
VerifySignature | signingRequestId, signedTxCbor, signerType, signerInfo, address? | SignatureVerifications |
SubmitVerifiedTransaction | (same 5 params) | TransactionSubmissions |
HSM (PKCS#11):
| Action | Params | Returns |
|---|---|---|
SignWithHsm | buildId: UUID, address?: Bech32 | SigningRequests |
SignAndSubmitWithHsm | buildId: UUID, address?: Bech32 | TransactionSubmissions |
GetHsmStatus | - | { connected, keyId, keyLabel, publicKeyHash, cardanoAddress } |
Optional address on the four signing actions enables consumer-side ownership verification.
Lifecycle: created → pending → verified → submitted.