Cardano SL Wallet Web API

Version: 0.4.3

This is an API for Cardano SL wallet.

Schemes:

Summary

Path Operation Description
/api/addresses/{address}/currencies/{currency} GET
/api/papervend/redemptions/ada POST
/api/profile GET
POST
/api/redemptions/ada POST
/api/reporting/electroncrash POST
/api/reporting/initialized POST
/api/settings/slots/duration GET
/api/settings/sync/progress GET
/api/settings/version GET
/api/test/reset POST
/api/txs/histories/{address} GET
/api/txs/histories/{address}/{search} GET
/api/txs/payments/{address}/{transaction} POST
/api/txs/payments/{passphrase}/{from}/{to}/{amount} POST
/api/txs/payments/{passphrase}/{from}/{to}/{amount}/{currency}/{title}/{description} POST
/api/update GET
POST
/api/wallets GET
/api/wallets/keys POST
/api/wallets/restore/{passphrase} POST
/api/wallets/{passphrase} POST
/api/wallets/{walletId} DELETE
GET
PUT

Paths

GET /api/addresses/{address}/currencies/{currency}

Returns True if given address is valid, False otherwise.

address path string
currency path string , x ∈ { ADA , BTC , ETH }

application/json;charset=utf-8

200 OK
404 Not Found

address or currency not found

POST /api/papervend/redemptions/ada

Redeem ADA, paper vending.

application/json;charset=utf-8

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid body

GET /api/profile

Get user profile's meta data.

application/json;charset=utf-8

200 OK

POST /api/profile

Update user profile.

application/json;charset=utf-8

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid body

POST /api/redemptions/ada

Redeem ADA.

application/json;charset=utf-8

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid body

POST /api/reporting/electroncrash

Send node's report on electron crash info.

application/json;charset=utf-8

200 OK

POST /api/reporting/initialized

Send node's report on initialization time.

application/json;charset=utf-8

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid body

GET /api/settings/slots/duration

Get blockchain slot duration in milliseconds.

application/json;charset=utf-8

200 OK

GET /api/settings/sync/progress

Sync progress, with info about local chain difficulty, network chain difficulty and connected peers.

application/json;charset=utf-8

200 OK

GET /api/settings/version

Get current version of the node.

application/json;charset=utf-8

200 OK

POST /api/test/reset

Delete all secret keys. It works in development mode only, returns HTTP 403 otherwise.

application/json;charset=utf-8

200 OK

GET /api/txs/histories/{address}

Get the history of transactions.

address path string
skip query integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }
limit query integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid limit or skip

404 Not Found

address not found

GET /api/txs/histories/{address}/{search}

Search in the history of transactions.

address path string
search path string
skip query integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }
limit query integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid limit or skip

404 Not Found

address or search not found

POST /api/txs/payments/{address}/{transaction}

Update payment transaction.

application/json;charset=utf-8

address path string
transaction path string

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid body

404 Not Found

address or transaction not found

POST /api/txs/payments/{passphrase}/{from}/{to}/{amount}

Create a new payment transaction.

passphrase path string
from path string
to path string
amount path integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }

application/json;charset=utf-8

200 OK
404 Not Found

passphrase or from or to or amount not found

POST /api/txs/payments/{passphrase}/{from}/{to}/{amount}/{currency}/{title}/{description}

Create a new payment transaction with extended information.

passphrase path string
from path string
to path string
amount path integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }
currency path string , x ∈ { ADA , BTC , ETH }
title path string
description path string

application/json;charset=utf-8

200 OK
404 Not Found

passphrase or from or to or amount or currency or title or description not found

GET /api/update

Get information about the next update.

application/json;charset=utf-8

200 OK

POST /api/update

Apply last update.

application/json;charset=utf-8

200 OK

GET /api/wallets

Get information about all available wallets.

application/json;charset=utf-8

200 OK

POST /api/wallets/keys

Import user's secret key from the path to the key file.

application/json;charset=utf-8

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid body

POST /api/wallets/restore/{passphrase}

Restore a wallet using a passphrase. Passphrases must be unique.

application/json;charset=utf-8

passphrase path string

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid body

404 Not Found

passphrase not found

POST /api/wallets/{passphrase}

Create a new wallet.

application/json;charset=utf-8

passphrase path string

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid body

404 Not Found

passphrase not found

DELETE /api/wallets/{walletId}

Delete a wallet by wallet's ID (address).

walletId path string

application/json;charset=utf-8

200 OK
404 Not Found

walletId not found

GET /api/wallets/{walletId}

Get information about a wallet by wallet's ID (address).

walletId path string

application/json;charset=utf-8

200 OK
404 Not Found

walletId not found

PUT /api/wallets/{walletId}

Update wallet's meta information.

application/json;charset=utf-8

walletId path string

application/json;charset=utf-8

200 OK
400 Bad Request

Invalid body

404 Not Found

walletId not found

Schema definitions

ApplicationName: object

getApplicationName: string

BackupPhrase: object

bpToList: string[]
string

BlockVersion: object

bvMajor: integer , { x ∈ ℤ | 0 ≤ x ≤ 65535 }
bvMinor: integer , { x ∈ ℤ | 0 ≤ x ≤ 65535 }
bvAlt: integer , { x ∈ ℤ | 0 ≤ x ≤ 255 }

CAddress: string

CCoin: object

getCoin: string

CCurrency: string , x ∈ { ADA , BTC , ETH }

ChainDifficulty: object

getChainDifficulty: integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }

CInitialized: object

cTotalTime: integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }
cPreInit: integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }

CPaperVendWalletRedeem: object

pvWalletId: CAddress
pvSeed: string
pvBackupPhrase: BackupPhrase

CProfile: object

cpLocale: string

CTType: object

CTIn: CTxMeta
CTOut: CTxMeta

CTx: object

ctId: CTxId
ctAmount: CCoin
ctFrom: object[][]
object[]
object
ctTo: object[][]
object[]
object
ctConfirmations: integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }
ctType: CTType

CTxId: string

CTxMeta: object

ctmCurrency: CCurrency
ctmTitle: string
ctmDescription: string
ctmDate: integer

CUpdateInfo: object

cuiSoftwareVersion: SoftwareVersion
cuiBlockVesion: BlockVersion
cuiScriptVersion: integer , { x ∈ ℤ | 0 ≤ x ≤ 65535 }
cuiImplicit: boolean
cuiVotesFor: integer , { x ∈ ℤ | -9223372036854776000 ≤ x ≤ 9223372036854776000 }
cuiVotesAgainst: integer , { x ∈ ℤ | -9223372036854776000 ≤ x ≤ 9223372036854776000 }
cuiPositiveStake: CCoin
cuiNegativeStake: CCoin

CWallet: object

cwAddress: CAddress
cwAmount: CCoin
cwMeta: CWalletMeta

CWalletAssurance: string , x ∈ { CWAStrict , CWANormal }

CWalletInit: object

cwBackupPhrase: BackupPhrase
cwInitMeta: CWalletMeta

CWalletMeta: object

cwType: CWalletType
cwCurrency: CCurrency
cwName: string
cwAssurance: CWalletAssurance
cwUnit: integer , { x ∈ ℤ | -9223372036854776000 ≤ x ≤ 9223372036854776000 }

CWalletRedeem: object

crWalletId: CAddress
crSeed: string

CWalletType: string , x ∈ { CWTPersonal , CWTShared }

Either WalletError (): object

Left: WalletError
Right: object[]

Either WalletError ([CTx],Word): object

Left: WalletError
Right: object[]
object

Either WalletError [CWallet]: object

Left: WalletError
Right: object[]

Either WalletError Bool: object

Left: WalletError
Right: boolean

Either WalletError CProfile: object

Left: WalletError
Right: CProfile

Either WalletError CTx: object

Left: WalletError
Right: CTx

Either WalletError CUpdateInfo: object

Left: WalletError
Right: CUpdateInfo

Either WalletError CWallet: object

Left: WalletError
Right: CWallet

Either WalletError SoftwareVersion: object

Either WalletError SyncProgress: object

Left: WalletError
Right: SyncProgress

Either WalletError Word: object

Left: WalletError
Right: integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }

SoftwareVersion: object

svAppName: ApplicationName
svNumber: integer , { x ∈ ℤ | 0 ≤ x ≤ 4294967295 }

SyncProgress: object

_spLocalCD: ChainDifficulty
_spNetworkCD: ChainDifficulty
_spPeers: integer , { x ∈ ℤ | 0 ≤ x ≤ 18446744073709552000 }

WalletError: string