No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
Version: 1.0.0
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
post /api/v1/arbitrators/{address}/deselect
Deselect arbitrator (deselectArbitrator)
Path parameters
address (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"arbitrators" : [ {
"address" : "address"
}, {
"address" : "address"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
ArbitratorList
Up
get /api/v1/arbitrators
Find available arbitrators (find)
Query parameters
acceptedOnly (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"arbitrators" : [ {
"address" : "address"
}, {
"address" : "address"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
ArbitratorList
Up
post /api/v1/arbitrators
Register yourself as arbitrator (register)
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
successful operation
Up
post /api/v1/arbitrators/{address}/select
Select arbitrator (selectArbitrator)
Path parameters
address (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"arbitrators" : [ {
"address" : "address"
}, {
"address" : "address"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
ArbitratorList
Up
delete /api/v1/arbitrators
Unregister yourself as arbitrator (unregister)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
successful operation
Up
get /api/v1/currencies
List available currencies (find)
Return type
Example data
Content-Type: application/json
{
"currencies" : [ {
"symbol" : "symbol",
"name" : "name",
"type" : "type"
}, {
"symbol" : "symbol",
"name" : "name",
"type" : "type"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
CurrencyList
List markets (find)
Return type
Example data
Content-Type: application/json
{
"markets" : [ {
"rsymbol" : "rsymbol",
"pair" : "pair",
"lsymbol" : "lsymbol"
}, {
"rsymbol" : "rsymbol",
"pair" : "pair",
"lsymbol" : "lsymbol"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
MarketList
Up
get /api/v1/network/bitcoin/status
Get Bitcoin network status (getBitcoinNetworkStatus)
Return type
Example data
Content-Type: application/json
{
"bitcoinNodesOption" : "PROVIDED",
"bitcoinNodes" : "bitcoinNodes",
"peers" : [ "peers", "peers" ],
"useTorForBitcoinJ" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
BitcoinNetworkStatus
Up
get /api/v1/network/p2p/status
Get P2P network status (getP2PNetworkStatus)
Return type
Example data
Content-Type: application/json
{
"address" : "address",
"p2pNetworkConnection" : [ {
"receivedBytes" : 6,
"outbound" : true,
"roundTripTime" : 5,
"peerType" : "SEED_NODE",
"creationDate" : 1,
"nodeAddress" : "nodeAddress",
"sentBytes" : 0
}, {
"receivedBytes" : 6,
"outbound" : true,
"roundTripTime" : 5,
"peerType" : "SEED_NODE",
"creationDate" : 1,
"nodeAddress" : "nodeAddress",
"sentBytes" : 0
} ],
"totalSentBytes" : 2,
"totalReceivedBytes" : 5
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
P2PNetworkStatus
Up
delete /api/v1/offers/{id}
Cancel offer (cancelOffer)
Path parameters
id (required)
Path Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
successful operation
Create offer (createOffer)
Request body
Return type
Example data
Content-Type: application/json
{
"date" : "2000-01-23T04:56:07.000+00:00",
"minAmount" : 3,
"sellerSecurityDeposit" : 7,
"isPrivateOffer" : true,
"isCurrencyForMakerFeeBtc" : true,
"makerPaymentAccountId" : "makerPaymentAccountId",
"hashOfChallenge" : "hashOfChallenge",
"buyerSecurityDeposit" : 1,
"offerFeePaymentTxId" : "offerFeePaymentTxId",
"useAutoClose" : true,
"blockHeightAtOfferCreation" : 6,
"useMarketBasedPrice" : true,
"counterCurrencyCode" : "counterCurrencyCode",
"makerFee" : 5,
"countryCode" : "countryCode",
"paymentMethodId" : "paymentMethodId",
"price" : 2,
"protocolVersion" : 4,
"id" : "id",
"maxTradePeriod" : 9,
"state" : "UNKNOWN",
"useReOpenAfterAutoClose" : true,
"versionNr" : "versionNr",
"upperClosePrice" : 1,
"direction" : "BUY",
"ownerNodeAddress" : "ownerNodeAddress",
"acceptedBankIds" : [ "acceptedBankIds", "acceptedBankIds" ],
"maxTradeLimit" : 7,
"amount" : 0,
"acceptedCountryCodes" : [ "acceptedCountryCodes", "acceptedCountryCodes" ],
"marketPriceMargin" : 2.3021358869347655,
"bankId" : "bankId",
"baseCurrencyCode" : "baseCurrencyCode",
"arbitratorNodeAddresses" : [ "arbitratorNodeAddresses", "arbitratorNodeAddresses" ],
"txFee" : 1,
"currencyCode" : "currencyCode",
"lowerClosePrice" : 5
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
OfferDetail
Find offers (find)
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"date" : "2000-01-23T04:56:07.000+00:00",
"minAmount" : 3,
"sellerSecurityDeposit" : 7,
"isPrivateOffer" : true,
"isCurrencyForMakerFeeBtc" : true,
"makerPaymentAccountId" : "makerPaymentAccountId",
"hashOfChallenge" : "hashOfChallenge",
"buyerSecurityDeposit" : 1,
"offerFeePaymentTxId" : "offerFeePaymentTxId",
"useAutoClose" : true,
"blockHeightAtOfferCreation" : 6,
"useMarketBasedPrice" : true,
"counterCurrencyCode" : "counterCurrencyCode",
"makerFee" : 5,
"countryCode" : "countryCode",
"paymentMethodId" : "paymentMethodId",
"price" : 2,
"protocolVersion" : 4,
"id" : "id",
"maxTradePeriod" : 9,
"state" : "UNKNOWN",
"useReOpenAfterAutoClose" : true,
"versionNr" : "versionNr",
"upperClosePrice" : 1,
"direction" : "BUY",
"ownerNodeAddress" : "ownerNodeAddress",
"acceptedBankIds" : [ "acceptedBankIds", "acceptedBankIds" ],
"maxTradeLimit" : 7,
"amount" : 0,
"acceptedCountryCodes" : [ "acceptedCountryCodes", "acceptedCountryCodes" ],
"marketPriceMargin" : 2.3021358869347655,
"bankId" : "bankId",
"baseCurrencyCode" : "baseCurrencyCode",
"arbitratorNodeAddresses" : [ "arbitratorNodeAddresses", "arbitratorNodeAddresses" ],
"txFee" : 1,
"currencyCode" : "currencyCode",
"lowerClosePrice" : 5
}, {
"date" : "2000-01-23T04:56:07.000+00:00",
"minAmount" : 3,
"sellerSecurityDeposit" : 7,
"isPrivateOffer" : true,
"isCurrencyForMakerFeeBtc" : true,
"makerPaymentAccountId" : "makerPaymentAccountId",
"hashOfChallenge" : "hashOfChallenge",
"buyerSecurityDeposit" : 1,
"offerFeePaymentTxId" : "offerFeePaymentTxId",
"useAutoClose" : true,
"blockHeightAtOfferCreation" : 6,
"useMarketBasedPrice" : true,
"counterCurrencyCode" : "counterCurrencyCode",
"makerFee" : 5,
"countryCode" : "countryCode",
"paymentMethodId" : "paymentMethodId",
"price" : 2,
"protocolVersion" : 4,
"id" : "id",
"maxTradePeriod" : 9,
"state" : "UNKNOWN",
"useReOpenAfterAutoClose" : true,
"versionNr" : "versionNr",
"upperClosePrice" : 1,
"direction" : "BUY",
"ownerNodeAddress" : "ownerNodeAddress",
"acceptedBankIds" : [ "acceptedBankIds", "acceptedBankIds" ],
"maxTradeLimit" : 7,
"amount" : 0,
"acceptedCountryCodes" : [ "acceptedCountryCodes", "acceptedCountryCodes" ],
"marketPriceMargin" : 2.3021358869347655,
"bankId" : "bankId",
"baseCurrencyCode" : "baseCurrencyCode",
"arbitratorNodeAddresses" : [ "arbitratorNodeAddresses", "arbitratorNodeAddresses" ],
"txFee" : 1,
"currencyCode" : "currencyCode",
"lowerClosePrice" : 5
} ],
"total" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
OfferList
Up
get /api/v1/offers/{id}
Get offer details (getOfferById)
Path parameters
id (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"date" : "2000-01-23T04:56:07.000+00:00",
"minAmount" : 3,
"sellerSecurityDeposit" : 7,
"isPrivateOffer" : true,
"isCurrencyForMakerFeeBtc" : true,
"makerPaymentAccountId" : "makerPaymentAccountId",
"hashOfChallenge" : "hashOfChallenge",
"buyerSecurityDeposit" : 1,
"offerFeePaymentTxId" : "offerFeePaymentTxId",
"useAutoClose" : true,
"blockHeightAtOfferCreation" : 6,
"useMarketBasedPrice" : true,
"counterCurrencyCode" : "counterCurrencyCode",
"makerFee" : 5,
"countryCode" : "countryCode",
"paymentMethodId" : "paymentMethodId",
"price" : 2,
"protocolVersion" : 4,
"id" : "id",
"maxTradePeriod" : 9,
"state" : "UNKNOWN",
"useReOpenAfterAutoClose" : true,
"versionNr" : "versionNr",
"upperClosePrice" : 1,
"direction" : "BUY",
"ownerNodeAddress" : "ownerNodeAddress",
"acceptedBankIds" : [ "acceptedBankIds", "acceptedBankIds" ],
"maxTradeLimit" : 7,
"amount" : 0,
"acceptedCountryCodes" : [ "acceptedCountryCodes", "acceptedCountryCodes" ],
"marketPriceMargin" : 2.3021358869347655,
"bankId" : "bankId",
"baseCurrencyCode" : "baseCurrencyCode",
"arbitratorNodeAddresses" : [ "arbitratorNodeAddresses", "arbitratorNodeAddresses" ],
"txFee" : 1,
"currencyCode" : "currencyCode",
"lowerClosePrice" : 5
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
OfferDetail
Up
post /api/v1/offers/{id}/take
Take offer (takeOffer)
Path parameters
id (required)
Path Parameter —
Request body
Return type
Example data
Content-Type: application/json
{
"sellerPaymentAccount" : {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
},
"payoutTxId" : "payoutTxId",
"arbitratorBtcPubKey" : [ "arbitratorBtcPubKey", "arbitratorBtcPubKey" ],
"isCurrencyForTakerFeeBtc" : true,
"tradingPeerNodeAddress" : "tradingPeerNodeAddress",
"offer" : {
"date" : "2000-01-23T04:56:07.000+00:00",
"minAmount" : 3,
"sellerSecurityDeposit" : 7,
"isPrivateOffer" : true,
"isCurrencyForMakerFeeBtc" : true,
"makerPaymentAccountId" : "makerPaymentAccountId",
"hashOfChallenge" : "hashOfChallenge",
"buyerSecurityDeposit" : 1,
"offerFeePaymentTxId" : "offerFeePaymentTxId",
"useAutoClose" : true,
"blockHeightAtOfferCreation" : 6,
"useMarketBasedPrice" : true,
"counterCurrencyCode" : "counterCurrencyCode",
"makerFee" : 5,
"countryCode" : "countryCode",
"paymentMethodId" : "paymentMethodId",
"price" : 2,
"protocolVersion" : 4,
"id" : "id",
"maxTradePeriod" : 9,
"state" : "UNKNOWN",
"useReOpenAfterAutoClose" : true,
"versionNr" : "versionNr",
"upperClosePrice" : 1,
"direction" : "BUY",
"ownerNodeAddress" : "ownerNodeAddress",
"acceptedBankIds" : [ "acceptedBankIds", "acceptedBankIds" ],
"maxTradeLimit" : 7,
"amount" : 0,
"acceptedCountryCodes" : [ "acceptedCountryCodes", "acceptedCountryCodes" ],
"marketPriceMargin" : 2.3021358869347655,
"bankId" : "bankId",
"baseCurrencyCode" : "baseCurrencyCode",
"arbitratorNodeAddresses" : [ "arbitratorNodeAddresses", "arbitratorNodeAddresses" ],
"txFee" : 1,
"currencyCode" : "currencyCode",
"lowerClosePrice" : 5
},
"disputeState" : "NO_DISPUTE",
"takerContractSignature" : "takerContractSignature",
"id" : "id",
"state" : "PREPARATION",
"arbitratorNodeAddress" : "arbitratorNodeAddress",
"mediatorNodeAddress" : "mediatorNodeAddress",
"takerFee" : 6,
"contractHash" : [ "contractHash", "contractHash" ],
"makerContractSignature" : "makerContractSignature",
"errorMessage" : "errorMessage",
"buyerPaymentAccount" : {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
},
"tradePeriodState" : "FIRST_HALF",
"tradeAmount" : 5,
"takeOfferDate" : 1,
"txFee" : 0,
"takerFeeTxId" : "takerFeeTxId",
"depositTxId" : "depositTxId",
"tradePrice" : 5,
"takerPaymentAccountId" : "takerPaymentAccountId",
"counterCurrencyTxId" : "counterCurrencyTxId"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
TradeDetails
Up
post /api/v1/payment-accounts
Create payment account (create)
Request body
Return type
Example data
Content-Type: application/json
{
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
PaymentAccount
Up
get /api/v1/payment-accounts
Get existing payment accounts (find)
Return type
Example data
Content-Type: application/json
{
"paymentAccounts" : [ {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
}, {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
PaymentAccountList
Up
delete /api/v1/payment-accounts/{id}
Remove payment account (removeById)
Path parameters
id (required)
Path Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
successful operation
Up
get /api/v1/preferences
Get preferences (getPreferences)
Return type
Example data
Content-Type: application/json
{
"ignoredTraders" : [ "ignoredTraders", "ignoredTraders" ],
"userCountry" : "userCountry",
"autoSelectArbitrators" : true,
"blockChainExplorer" : "blockChainExplorer",
"maxPriceDistance" : 0.8008281904610115,
"useCustomWithdrawalTxFee" : true,
"preferredTradeCurrency" : "preferredTradeCurrency",
"fiatCurrencies" : [ "fiatCurrencies", "fiatCurrencies" ],
"baseCurrencyNetwork" : "baseCurrencyNetwork",
"withdrawalTxFee" : 6,
"cryptoCurrencies" : [ "cryptoCurrencies", "cryptoCurrencies" ],
"userLanguage" : "userLanguage"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Preferences
Up
get /api/v1/preferences/available-values
Get available preferences values (getPreferencesAvailableValues)
Return type
Example data
Content-Type: application/json
{
"blockChainExplorers" : [ "blockChainExplorers", "blockChainExplorers" ],
"userCountries" : [ "userCountries", "userCountries" ],
"fiatCurrencies" : [ "fiatCurrencies", "fiatCurrencies" ],
"cryptoCurrencies" : [ "cryptoCurrencies", "cryptoCurrencies" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
PreferencesAvailableValues
Up
put /api/v1/preferences
Set preferences (setPreferences)
Supports partial update
Request body
Return type
Example data
Content-Type: application/json
{
"ignoredTraders" : [ "ignoredTraders", "ignoredTraders" ],
"userCountry" : "userCountry",
"autoSelectArbitrators" : true,
"blockChainExplorer" : "blockChainExplorer",
"maxPriceDistance" : 0.8008281904610115,
"useCustomWithdrawalTxFee" : true,
"preferredTradeCurrency" : "preferredTradeCurrency",
"fiatCurrencies" : [ "fiatCurrencies", "fiatCurrencies" ],
"baseCurrencyNetwork" : "baseCurrencyNetwork",
"withdrawalTxFee" : 6,
"cryptoCurrencies" : [ "cryptoCurrencies", "cryptoCurrencies" ],
"userLanguage" : "userLanguage"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Preferences
List trades (find)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"trades" : [ {
"sellerPaymentAccount" : {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
},
"payoutTxId" : "payoutTxId",
"arbitratorBtcPubKey" : [ "arbitratorBtcPubKey", "arbitratorBtcPubKey" ],
"isCurrencyForTakerFeeBtc" : true,
"tradingPeerNodeAddress" : "tradingPeerNodeAddress",
"offer" : {
"date" : "2000-01-23T04:56:07.000+00:00",
"minAmount" : 3,
"sellerSecurityDeposit" : 7,
"isPrivateOffer" : true,
"isCurrencyForMakerFeeBtc" : true,
"makerPaymentAccountId" : "makerPaymentAccountId",
"hashOfChallenge" : "hashOfChallenge",
"buyerSecurityDeposit" : 1,
"offerFeePaymentTxId" : "offerFeePaymentTxId",
"useAutoClose" : true,
"blockHeightAtOfferCreation" : 6,
"useMarketBasedPrice" : true,
"counterCurrencyCode" : "counterCurrencyCode",
"makerFee" : 5,
"countryCode" : "countryCode",
"paymentMethodId" : "paymentMethodId",
"price" : 2,
"protocolVersion" : 4,
"id" : "id",
"maxTradePeriod" : 9,
"state" : "UNKNOWN",
"useReOpenAfterAutoClose" : true,
"versionNr" : "versionNr",
"upperClosePrice" : 1,
"direction" : "BUY",
"ownerNodeAddress" : "ownerNodeAddress",
"acceptedBankIds" : [ "acceptedBankIds", "acceptedBankIds" ],
"maxTradeLimit" : 7,
"amount" : 0,
"acceptedCountryCodes" : [ "acceptedCountryCodes", "acceptedCountryCodes" ],
"marketPriceMargin" : 2.3021358869347655,
"bankId" : "bankId",
"baseCurrencyCode" : "baseCurrencyCode",
"arbitratorNodeAddresses" : [ "arbitratorNodeAddresses", "arbitratorNodeAddresses" ],
"txFee" : 1,
"currencyCode" : "currencyCode",
"lowerClosePrice" : 5
},
"disputeState" : "NO_DISPUTE",
"takerContractSignature" : "takerContractSignature",
"id" : "id",
"state" : "PREPARATION",
"arbitratorNodeAddress" : "arbitratorNodeAddress",
"mediatorNodeAddress" : "mediatorNodeAddress",
"takerFee" : 6,
"contractHash" : [ "contractHash", "contractHash" ],
"makerContractSignature" : "makerContractSignature",
"errorMessage" : "errorMessage",
"buyerPaymentAccount" : {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
},
"tradePeriodState" : "FIRST_HALF",
"tradeAmount" : 5,
"takeOfferDate" : 1,
"txFee" : 0,
"takerFeeTxId" : "takerFeeTxId",
"depositTxId" : "depositTxId",
"tradePrice" : 5,
"takerPaymentAccountId" : "takerPaymentAccountId",
"counterCurrencyTxId" : "counterCurrencyTxId"
}, {
"sellerPaymentAccount" : {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
},
"payoutTxId" : "payoutTxId",
"arbitratorBtcPubKey" : [ "arbitratorBtcPubKey", "arbitratorBtcPubKey" ],
"isCurrencyForTakerFeeBtc" : true,
"tradingPeerNodeAddress" : "tradingPeerNodeAddress",
"offer" : {
"date" : "2000-01-23T04:56:07.000+00:00",
"minAmount" : 3,
"sellerSecurityDeposit" : 7,
"isPrivateOffer" : true,
"isCurrencyForMakerFeeBtc" : true,
"makerPaymentAccountId" : "makerPaymentAccountId",
"hashOfChallenge" : "hashOfChallenge",
"buyerSecurityDeposit" : 1,
"offerFeePaymentTxId" : "offerFeePaymentTxId",
"useAutoClose" : true,
"blockHeightAtOfferCreation" : 6,
"useMarketBasedPrice" : true,
"counterCurrencyCode" : "counterCurrencyCode",
"makerFee" : 5,
"countryCode" : "countryCode",
"paymentMethodId" : "paymentMethodId",
"price" : 2,
"protocolVersion" : 4,
"id" : "id",
"maxTradePeriod" : 9,
"state" : "UNKNOWN",
"useReOpenAfterAutoClose" : true,
"versionNr" : "versionNr",
"upperClosePrice" : 1,
"direction" : "BUY",
"ownerNodeAddress" : "ownerNodeAddress",
"acceptedBankIds" : [ "acceptedBankIds", "acceptedBankIds" ],
"maxTradeLimit" : 7,
"amount" : 0,
"acceptedCountryCodes" : [ "acceptedCountryCodes", "acceptedCountryCodes" ],
"marketPriceMargin" : 2.3021358869347655,
"bankId" : "bankId",
"baseCurrencyCode" : "baseCurrencyCode",
"arbitratorNodeAddresses" : [ "arbitratorNodeAddresses", "arbitratorNodeAddresses" ],
"txFee" : 1,
"currencyCode" : "currencyCode",
"lowerClosePrice" : 5
},
"disputeState" : "NO_DISPUTE",
"takerContractSignature" : "takerContractSignature",
"id" : "id",
"state" : "PREPARATION",
"arbitratorNodeAddress" : "arbitratorNodeAddress",
"mediatorNodeAddress" : "mediatorNodeAddress",
"takerFee" : 6,
"contractHash" : [ "contractHash", "contractHash" ],
"makerContractSignature" : "makerContractSignature",
"errorMessage" : "errorMessage",
"buyerPaymentAccount" : {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
},
"tradePeriodState" : "FIRST_HALF",
"tradeAmount" : 5,
"takeOfferDate" : 1,
"txFee" : 0,
"takerFeeTxId" : "takerFeeTxId",
"depositTxId" : "depositTxId",
"tradePrice" : 5,
"takerPaymentAccountId" : "takerPaymentAccountId",
"counterCurrencyTxId" : "counterCurrencyTxId"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
TradeList
Up
get /api/v1/trades/{id}
Get trade details (getById)
Path parameters
id (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"sellerPaymentAccount" : {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
},
"payoutTxId" : "payoutTxId",
"arbitratorBtcPubKey" : [ "arbitratorBtcPubKey", "arbitratorBtcPubKey" ],
"isCurrencyForTakerFeeBtc" : true,
"tradingPeerNodeAddress" : "tradingPeerNodeAddress",
"offer" : {
"date" : "2000-01-23T04:56:07.000+00:00",
"minAmount" : 3,
"sellerSecurityDeposit" : 7,
"isPrivateOffer" : true,
"isCurrencyForMakerFeeBtc" : true,
"makerPaymentAccountId" : "makerPaymentAccountId",
"hashOfChallenge" : "hashOfChallenge",
"buyerSecurityDeposit" : 1,
"offerFeePaymentTxId" : "offerFeePaymentTxId",
"useAutoClose" : true,
"blockHeightAtOfferCreation" : 6,
"useMarketBasedPrice" : true,
"counterCurrencyCode" : "counterCurrencyCode",
"makerFee" : 5,
"countryCode" : "countryCode",
"paymentMethodId" : "paymentMethodId",
"price" : 2,
"protocolVersion" : 4,
"id" : "id",
"maxTradePeriod" : 9,
"state" : "UNKNOWN",
"useReOpenAfterAutoClose" : true,
"versionNr" : "versionNr",
"upperClosePrice" : 1,
"direction" : "BUY",
"ownerNodeAddress" : "ownerNodeAddress",
"acceptedBankIds" : [ "acceptedBankIds", "acceptedBankIds" ],
"maxTradeLimit" : 7,
"amount" : 0,
"acceptedCountryCodes" : [ "acceptedCountryCodes", "acceptedCountryCodes" ],
"marketPriceMargin" : 2.3021358869347655,
"bankId" : "bankId",
"baseCurrencyCode" : "baseCurrencyCode",
"arbitratorNodeAddresses" : [ "arbitratorNodeAddresses", "arbitratorNodeAddresses" ],
"txFee" : 1,
"currencyCode" : "currencyCode",
"lowerClosePrice" : 5
},
"disputeState" : "NO_DISPUTE",
"takerContractSignature" : "takerContractSignature",
"id" : "id",
"state" : "PREPARATION",
"arbitratorNodeAddress" : "arbitratorNodeAddress",
"mediatorNodeAddress" : "mediatorNodeAddress",
"takerFee" : 6,
"contractHash" : [ "contractHash", "contractHash" ],
"makerContractSignature" : "makerContractSignature",
"errorMessage" : "errorMessage",
"buyerPaymentAccount" : {
"accountName" : "accountName",
"tradeCurrencies" : [ "tradeCurrencies", "tradeCurrencies" ],
"paymentMethod" : "paymentMethod",
"id" : "id",
"paymentDetails" : "paymentDetails",
"selectedTradeCurrency" : "selectedTradeCurrency"
},
"tradePeriodState" : "FIRST_HALF",
"tradeAmount" : 5,
"takeOfferDate" : 1,
"txFee" : 0,
"takerFeeTxId" : "takerFeeTxId",
"depositTxId" : "depositTxId",
"tradePrice" : 5,
"takerPaymentAccountId" : "takerPaymentAccountId",
"counterCurrencyTxId" : "counterCurrencyTxId"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
TradeDetails
Up
post /api/v1/trades/{id}/move-funds-to-bisq-wallet
Move funds to Bisq wallet (moveFundsToBisqWallet)
Path parameters
id (required)
Path Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
successful operation
Up
post /api/v1/trades/{id}/payment-received
Confirm payment has been received (paymentReceived)
Path parameters
id (required)
Path Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
successful operation
Up
post /api/v1/trades/{id}/payment-started
Confirm payment has started (paymentStarted)
Path parameters
id (required)
Path Parameter —
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
successful operation
Up
get /api/v1/wallet/addresses
Get wallet addresses (getAddresses)
Query parameters
purpose (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"total" : 1,
"walletAddresses" : [ {
"address" : "address",
"balance" : 0,
"context" : "ARBITRATOR",
"offerId" : "offerId",
"confirmations" : 6
}, {
"address" : "address",
"balance" : 0,
"context" : "ARBITRATOR",
"offerId" : "offerId",
"confirmations" : 6
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
WalletAddressList
Up
post /api/v1/wallet/addresses
Get or create wallet address (getOrCreateAvailableUnusedWalletAddresses)
Return type
Example data
Content-Type: application/json
{
"address" : "address",
"balance" : 0,
"context" : "ARBITRATOR",
"offerId" : "offerId",
"confirmations" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
WalletAddress
Up
get /api/v1/wallet/transactions
Get wallet transactions (getTransactions)
Return type
Example data
Content-Type: application/json
{
"total" : 7,
"transactions" : [ {
"address" : "address",
"valueSentFromMe" : 5,
"inbound" : true,
"fee" : 6,
"updateTime" : 0,
"valueSentToMe" : 5,
"confirmations" : 2,
"value" : 1,
"hash" : "hash"
}, {
"address" : "address",
"valueSentFromMe" : 5,
"inbound" : true,
"fee" : 6,
"updateTime" : 0,
"valueSentToMe" : 5,
"confirmations" : 2,
"value" : 1,
"hash" : "hash"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
WalletTransactionList
Get wallet details (getWalletDetails)
Return type
Example data
Content-Type: application/json
{
"reservedBalance" : 6,
"lockedBalance" : 1,
"availableBalance" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
WalletDetails
Up
post /api/v1/wallet/withdraw
Withdraw funds (withdrawFunds)
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
successful operation
[ Jump to Methods ]
Table of Contents
Arbitrator
-
ArbitratorList
-
ArbitratorRegistration
-
BitcoinNetworkStatus
-
Currency
-
CurrencyList
-
Market
-
MarketList
-
OfferDetail
-
OfferList
-
OfferToCreate
-
P2PNetworkConnection
-
P2PNetworkStatus
-
PaymentAccount
-
PaymentAccountList
-
Preferences
-
PreferencesAvailableValues
-
TakeOffer
-
TradeDetails
-
TradeList
-
WalletAddress
-
WalletAddressList
-
WalletDetails
-
WalletTransaction
-
WalletTransactionList
-
WithdrawFundsForm
-
AliPayPaymentAccount
-
CashAppPaymentAccount
-
CashDepositPaymentAccount
-
ChaseQuickPayPaymentAccount
-
ClearXchangePaymentAccount
-
CryptoCurrencyPaymentAccount
-
FasterPaymentsPaymentAccount
-
InteracETransferPaymentAccount
-
MoneyBeamPaymentAccount
-
NationalBankAccountPaymentAccount
-
OKPayPaymentAccount
-
PerfectMoneyPaymentAccount
-
PopmoneyPaymentAccount
-
RevolutPaymentAccount
-
SameBankAccountPaymentAccount
-
SepaInstantPaymentAccount
-
SepaPaymentAccount
-
SpecificBanksAccountPaymentAccount
-
SwishPaymentAccount
-
USPostalMoneyOrderPaymentAccount
-
UpholdPaymentAccount
-
VenmoPaymentAccount
-
WesternUnionPaymentAccount
-
arbitrators (optional)
total (optional)
bitcoinNodesOption (optional)
PROVIDED
CUSTOM
PUBLIC
bitcoinNodes (optional)
peers (optional)
useTorForBitcoinJ (optional)
symbol (optional)
name (optional)
type (optional)
pair (optional)
lsymbol (optional)
rsymbol (optional)
acceptedBankIds (optional)
acceptedCountryCodes (optional)
amount (optional)
arbitratorNodeAddresses (optional)
bankId (optional)
baseCurrencyCode (optional)
blockHeightAtOfferCreation (optional)
buyerSecurityDeposit (optional)
counterCurrencyCode (optional)
countryCode (optional)
currencyCode (optional)
date (optional)
direction (optional)
BUY
SELL
hashOfChallenge (optional)
id (optional)
isCurrencyForMakerFeeBtc (optional)
isPrivateOffer (optional)
lowerClosePrice (optional)
makerFee (optional)
makerPaymentAccountId (optional)
marketPriceMargin (optional)
maxTradeLimit (optional)
maxTradePeriod (optional)
minAmount (optional)
offerFeePaymentTxId (optional)
ownerNodeAddress (optional)
paymentMethodId (optional)
price (optional)
protocolVersion (optional)
sellerSecurityDeposit (optional)
state (optional)
UNKNOWN
OFFER_FEE_PAID
AVAILABLE
NOT_AVAILABLE
REMOVED
MAKER_OFFLINE
txFee (optional)
upperClosePrice (optional)
useAutoClose (optional)
useMarketBasedPrice (optional)
useReOpenAfterAutoClose (optional)
versionNr (optional)
offers (optional)
total (optional)
fundUsingBisqWallet (optional)
offerId (optional)
accountId (optional)
direction
priceType
marketPair (optional)
percentageFromMarketPrice (optional)
fixedPrice (optional)
amount (optional)
minAmount (optional)
buyerSecurityDeposit (optional)
nodeAddress (optional)
sentBytes (optional)
receivedBytes (optional)
peerType (optional)
SEED_NODE
PEER
DIRECT_MSG_PEER
INITIAL_DATA_REQUEST
outbound (optional)
creationDate (optional)
roundTripTime (optional)
address (optional)
p2pNetworkConnection (optional)
totalReceivedBytes (optional)
totalSentBytes (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
paymentAccounts (optional)
autoSelectArbitrators (optional)
baseCurrencyNetwork (optional)
blockChainExplorer (optional)
cryptoCurrencies (optional)
fiatCurrencies (optional)
ignoredTraders (optional)
maxPriceDistance (optional)
preferredTradeCurrency (optional)
useCustomWithdrawalTxFee (optional)
userCountry (optional)
userLanguage (optional)
withdrawalTxFee (optional)
blockChainExplorers (optional)
cryptoCurrencies (optional)
fiatCurrencies (optional)
userCountries (optional)
paymentAccountId (optional)
amount
buyerPaymentAccount (optional)
sellerPaymentAccount (optional)
id (optional)
offer (optional)
isCurrencyForTakerFeeBtc (optional)
txFee (optional)
takerFee (optional)
takeOfferDate (optional)
takerFeeTxId (optional)
depositTxId (optional)
payoutTxId (optional)
tradeAmount (optional)
tradePrice (optional)
state (optional)
PREPARATION
TAKER_PUBLISHED_TAKER_FEE_TX
MAKER_SENT_PUBLISH_DEPOSIT_TX_REQUEST
MAKER_SAW_ARRIVED_PUBLISH_DEPOSIT_TX_REQUEST
MAKER_STORED_IN_MAILBOX_PUBLISH_DEPOSIT_TX_REQUEST
MAKER_SEND_FAILED_PUBLISH_DEPOSIT_TX_REQUEST
TAKER_RECEIVED_PUBLISH_DEPOSIT_TX_REQUEST
TAKER_PUBLISHED_DEPOSIT_TX
TAKER_SENT_DEPOSIT_TX_PUBLISHED_MSG
TAKER_SAW_ARRIVED_DEPOSIT_TX_PUBLISHED_MSG
TAKER_STORED_IN_MAILBOX_DEPOSIT_TX_PUBLISHED_MSG
TAKER_SEND_FAILED_DEPOSIT_TX_PUBLISHED_MSG
MAKER_RECEIVED_DEPOSIT_TX_PUBLISHED_MSG
MAKER_SAW_DEPOSIT_TX_IN_NETWORK
DEPOSIT_CONFIRMED_IN_BLOCK_CHAIN
BUYER_CONFIRMED_IN_UI_FIAT_PAYMENT_INITIATED
BUYER_SENT_FIAT_PAYMENT_INITIATED_MSG
BUYER_SAW_ARRIVED_FIAT_PAYMENT_INITIATED_MSG
BUYER_STORED_IN_MAILBOX_FIAT_PAYMENT_INITIATED_MSG
BUYER_SEND_FAILED_FIAT_PAYMENT_INITIATED_MSG
SELLER_RECEIVED_FIAT_PAYMENT_INITIATED_MSG
SELLER_CONFIRMED_IN_UI_FIAT_PAYMENT_RECEIPT
SELLER_PUBLISHED_PAYOUT_TX
SELLER_SENT_PAYOUT_TX_PUBLISHED_MSG
SELLER_SAW_ARRIVED_PAYOUT_TX_PUBLISHED_MSG
SELLER_STORED_IN_MAILBOX_PAYOUT_TX_PUBLISHED_MSG
SELLER_SEND_FAILED_PAYOUT_TX_PUBLISHED_MSG
BUYER_RECEIVED_PAYOUT_TX_PUBLISHED_MSG
BUYER_SAW_PAYOUT_TX_IN_NETWORK
WITHDRAW_COMPLETED
disputeState (optional)
NO_DISPUTE
DISPUTE_REQUESTED
DISPUTE_STARTED_BY_PEER
DISPUTE_CLOSED
tradePeriodState (optional)
FIRST_HALF
SECOND_HALF
TRADE_PERIOD_OVER
arbitratorBtcPubKey (optional)
contractHash (optional)
mediatorNodeAddress (optional)
takerContractSignature (optional)
makerContractSignature (optional)
arbitratorNodeAddress (optional)
tradingPeerNodeAddress (optional)
takerPaymentAccountId (optional)
errorMessage (optional)
counterCurrencyTxId (optional)
trades (optional)
total (optional)
address (optional)
balance (optional)
confirmations (optional)
context (optional)
ARBITRATOR
AVAILABLE
OFFER_FUNDING
RESERVED_FOR_TRADE
MULTI_SIG
TRADE_PAYOUT
offerId (optional)
walletAddresses (optional)
total (optional)
availableBalance (optional)
reservedBalance (optional)
lockedBalance (optional)
updateTime (optional)
hash (optional)
fee (optional)
value (optional)
valueSentToMe (optional)
valueSentFromMe (optional)
confirmations (optional)
inbound (optional)
address (optional)
transactions (optional)
total (optional)
amount (optional)
feeExcluded (optional)
sourceAddresses (optional)
targetAddress (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountNr (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
cashTag (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountNr (optional)
accountType (optional)
bankId (optional)
bankName (optional)
branchId (optional)
countryCode (optional)
holderName (optional)
holderEmail (optional)
holderTaxId (optional)
requirements (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
email (optional)
holderName (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
emailOrMobileNr (optional)
holderName (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
address (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountNr (optional)
sortCode (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
emailOrMobileNr (optional)
holderName (optional)
question (optional)
answer (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountId (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountNr (optional)
accountType (optional)
bankId (optional)
bankName (optional)
branchId (optional)
countryCode (optional)
holderName (optional)
holderTaxId (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountNr (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountNr (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountId (optional)
holderName (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountId (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountNr (optional)
accountType (optional)
bankId (optional)
bankName (optional)
branchId (optional)
countryCode (optional)
holderName (optional)
holderTaxId (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
countryCode (optional)
holderName (optional)
bic (optional)
iban (optional)
acceptedCountries (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
countryCode (optional)
holderName (optional)
bic (optional)
iban (optional)
acceptedCountries (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
acceptedBanks (optional)
accountNr (optional)
accountType (optional)
bankId (optional)
bankName (optional)
branchId (optional)
countryCode (optional)
holderName (optional)
holderTaxId (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
mobileNr (optional)
holderName (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
holderName (optional)
postalAddress (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
accountId (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
holderName (optional)
venmoUserName (optional)
id (optional)
accountName (optional)
paymentDetails (optional)
paymentMethod (optional)
selectedTradeCurrency (optional)
tradeCurrencies (optional)
city (optional)
countryCode (optional)
email (optional)
holderName (optional)
state (optional)