API Reference

ODATANO registers three OData V4 services in your CAP application. All services support $filter, $select, $expand, $top, $skip, $count, and $orderby.

CardanoODataService

Path: /odata/v4/cardano-odata/

Read-only access to Cardano blockchain data via lazy on-demand indexing with TTL-based refresh.

Entities

EntityDescription
NetworkInformationNetwork info, genesis parameters
BlocksBlock data (height, hash, slot, epoch, time)
EpochsEpoch info and protocol parameters
TransactionsTransaction metadata
TransactionInputsInput UTxOs per transaction
TransactionOutputsOutput UTxOs per transaction
TransactionInputAssetsNative assets in inputs
TransactionOutputAssetsNative assets in outputs
TransactionMetadataCIP-20 and arbitrary metadata
AddressesAddress details and balance
AddressAssetsNative assets held by an address
AddressUTxOsUTxO set for an address
AddressTransactionsTransaction history for an address
UTxOAssetsAssets within a specific UTxO
PoolsStake pool info and metrics
AccountsStake account / delegation info
DrepsGovernance DRep information
LedgerProtocolParametersCurrent protocol parameters

Actions (POST)

ActionParametersReturns
GetTransactionByHashhashTransactions
GetAddressByBech32addressAddresses
GetUTxOsByAddressaddressAddressUTxOs[]
GetAssetsByAddressaddressAddressAssets[]
GetMetadataByTxHashtx_hashTransactionMetadata[]
GetPoolByIdpoolIdPools
GetAccountByStakeAddressstakeAddressAccounts
GetDrepByIddrepIdDreps
GetTransactionsByAddressaddressAddressTransactions[]
GetAssetHistoryunitAsset history
GetUTxOByReftxHash, outputIndexAddressUTxOs
GetInputsByTxHashhashTransactionInputs[]
GetOutputsByTxHashhashTransactionOutputs[]
GetInputAssetsByTxHashhashTransactionInputAssets[]
GetOutputAssetsByTxHashhashTransactionOutputAssets[]

OData Query Examples

# Latest block
GET /odata/v4/cardano-odata/Blocks?$orderby=height desc&$top=1

# Read by key
GET /odata/v4/cardano-odata/Transactions('<64-hex-hash>')
GET /odata/v4/cardano-odata/Addresses('addr_test1...')

# Filter with select
GET /odata/v4/cardano-odata/Blocks?$filter=epoch eq 500&$select=hash,height,time

CardanoTransactionService

Path: /odata/v4/cardano-transaction/

Build, track, and submit Cardano transactions. Supports two builder backends: csl and buildooor.

Entities

EntityDescription
TransactionBuildsPending/completed transaction builds
TransactionSubmissionsSubmission records and status
BuildInputsUTxO inputs used in a build
BuildOutputsOutputs in a build
BuildAssetsNative assets in a build
BuildMetadataMetadata attached to a build
ProtocolParametersCacheCached protocol parameters
NetworkParametersCacheCached network parameters

Actions (POST)

ActionDescription
BuildSimpleAdaTransactionADA transfer between two addresses
BuildMultiAssetTransactionTransfer native assets
BuildTokenMintTransactionMint new native tokens
BuildMetadataTransactionAttach CIP-20 metadata
SubmitSignedTransactionSubmit a signed transaction (CBOR)
GetBuildStatusCheck build/submission status
GetTransactionStatusCheck on-chain confirmation
CancelBuildCancel a pending build
RebuildTransactionRebuild a failed transaction
EstimateFeeEstimate transaction fees
ValidateAddressesValidate address format

CardanoSignService

Path: /odata/v4/cardano-sign/

External signing workflow — ODATANO never holds private keys. Signing requests are created server-side and fulfilled by external signers.

Entities

EntityDescription
SigningRequestsPending signing requests
SigningAuditLogImmutable audit trail of signing events
HsmConfigurationsHSM device configurations
VerifiedTransactionsSuccessfully verified and submitted txs
SigningPoliciesAuthorization policies for signing

Actions (POST)

ActionDescription
CreateSigningRequestCreate a signing request from a buildId
SubmitVerifiedTransactionSubmit after external signing
SignWithHsmTrigger HSM signing (PKCS#11)
VerifySignatureVerify a signature without submitting
GetSigningRequestRetrieve a signing request by ID
CancelSigningRequestCancel a pending signing request
ListPendingRequestsList all open signing requests
GetAuditLogRetrieve signing audit trail

Supported Signers

Signer TypesignerType valueNotes
CIP-30 browser walletbrowser-walletNami, Eternl, Lace, Yoroi
Cardano CLIcardano-cliResponse includes CLI command
YubiHSMhsmPKCS#11 via SignWithHsm
AWS CloudHSMhsmPKCS#11 via SignWithHsm
Thales Luna HSMhsmPKCS#11 via SignWithHsm

Technology Stack

ComponentTechnology
FrameworkSAP CAP 9.x
LanguageTypeScript 5.x
RuntimeNode.js 20.x / 22.x
DatabaseSQLite (dev) / SAP HANA (prod)
Blockchain APIsBlockfrost, Koios, Ogmios
TX BuildersCSL (Cardano Serialization Library), Buildooor
TestingJest — 1122 tests, 99% coverage
LicenseApache 2.0