Skip to content
coinkun docs
Coinkun home Dashboard

API REFERENCE v1

Wallet

A single-currency interface for addresses, balances and transfers. This page describes the planned contract; Wallet API is not implemented in this version of Coinkun.

On this page

#Create Wallet

Planned

A wallet has its own public identifier and Transfer Key. It is distinct from a multi-currency account.

POST/wallets

Request

  • HTTP MethodPOST
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets
ParameterTypeDescriptionRequired
currencystringCurrency identifier; ltc is used throughout these examples.Yes
callbackobjectNotification configuration with method, url and optional data.No
destinationsarrayForwarding destinations containing address and amount.No
destination_rulesarrayProposed automatic-transfer conditions; rule syntax is not defined for Coinkun yet.No
feestringProposed network fee strategy.No
processing-fee-policystringProcessing fee policy; no Coinkun pricing policy is enabled yet.No
curl --request POST "https://coinkun.com/api/v1/wallets" \
  --header 'Content-Type: application/json' \
  --data '{
  "currency": "ltc",
  "callback": {
    "method": "POST",
    "url": "https://merchant.example/webhooks/coinkun",
    "data": {
      "order_id": "ORDER_ID"
    }
  }
}'

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Wallet Info

Planned
GET/wallets/{wallet}

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Wallet Balance

Planned
GET/wallets/{wallet}/balance

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/balance
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
addressesstringComma-separated addresses to include.No
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/balance"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Generate Address

Planned
POST/wallets/{wallet}/addresses

Request

  • HTTP MethodPOST
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/addresses
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
addr-typestringRequested address encoding; p2wpkh is used in the example.No
callbackobjectAddress notification configuration.No
curl --request POST "https://coinkun.com/api/v1/wallets/${WALLET_ID}/addresses" \
  --header 'Content-Type: application/json' \
  --data '{
  "addr-type": "p2wpkh",
  "callback": {
    "method": "POST",
    "url": "https://merchant.example/webhooks/coinkun",
    "data": {
      "order_id": "ORDER_ID"
    }
  }
}'

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Address Info

Planned
GET/wallets/{wallet}/addresses/{address}

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/addresses/{address}
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
addressstringAddress belonging to this wallet.Yes
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/addresses/${ADDRESS}"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Address Balance

Planned
GET/wallets/{wallet}/addresses/{address}/balance

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/addresses/{address}/balance
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
addressstringAddress belonging to this wallet.Yes
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/addresses/${ADDRESS}/balance"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Wallet Addresses

Planned
GET/wallets/{wallet}/addresses

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/addresses
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
limitintegerPage size; reference default is 10.No
offsetintegerZero-based offset; reference default is 0.No
qstringFilter expression, for example address:LTC_ADDRESS,empty:false.No
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/addresses" \
  --get \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Estimation

Planned

Preview transfer destinations and fees before authorizing a payment.

GET/wallets/{wallet}/transfer

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/transfer
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
destinationsstringComma-separated address:amount pairs, for example LTC_DESTINATION_ADDRESS:250000.Yes
feestringRequested network fee strategy.No
subtract-fee-from-amountbooleanDeduct fees from destination amounts instead of adding them.No
addressesstringComma-separated source addresses.No
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/transfer" \
  --get \
  --data-urlencode "destinations=LTC_DESTINATION_ADDRESS:250000"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Transfer

Planned
POST/wallets/{wallet}/transfer

Request

  • HTTP MethodPOST
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/transfer
  • Authorization
    Bearer YOUR_ACCESS_TOKEN Planned
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
transfer-keystringRequired when an access token is not supplied.No
destinationsarrayRecipient objects with address and integer atomic amount or percentage string.Yes
feestringRequested network fee strategy.No
subtract-fee-from-amountbooleanDeduct fees from destination amounts.No
addressesarrayRestrict funding to these wallet addresses.No
curl --request POST "https://coinkun.com/api/v1/wallets/${WALLET_ID}/transfer" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "transfer-key": "TRANSFER_KEY",
  "destinations": [
    {
      "address": "LTC_DESTINATION_ADDRESS",
      "amount": 250000
    }
  ],
  "fee": "normal",
  "subtract-fee-from-amount": false
}'

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Wallet History

Planned
GET/wallets/{wallet}/history

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/history
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
addressesstringComma-separated address scope.No
limitintegerPage size; reference default is 10.No
offsetintegerZero-based offset.No
qstringComma-separated filters: address, date-from, date-to and item-type (payment or receipt).No
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/history" \
  --get \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Wallet History Item

Planned

A history item is either an outgoing payment or an incoming receipt. A receipt can include several outputs.

GET/wallets/{wallet}/history/{HistoryItemID}

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/history/{HistoryItemID}
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
HistoryItemIDstringPayment or receipt identifier.Yes
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/history/${HISTORY_ITEM_ID}"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Address History

Planned
GET/wallets/{wallet}/addresses/{address}/history

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/addresses/{address}/history
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
addressstringAddress belonging to this wallet.Yes
limitintegerPage size; reference default is 10.No
offsetintegerZero-based offset.No
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/addresses/${ADDRESS}/history" \
  --get \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Wallet Callback Info

Planned
GET/wallets/{wallet}/callback

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/callback
  • Authorization
    Bearer YOUR_ACCESS_TOKEN Planned
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
transfer-keystringRequired without an access token.No
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/callback" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Address Callback Info

Planned
GET/wallets/{wallet}/addresses/{address}/callback

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/addresses/{address}/callback
  • Authorization
    Bearer YOUR_ACCESS_TOKEN Planned
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
addressstringAddress belonging to this wallet.Yes
transfer-keystringRequired without an access token.No
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/addresses/${ADDRESS}/callback" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Address Callback Log

Planned
GET/wallets/{wallet}/addresses/{address}/callback-log

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}/addresses/{address}/callback-log
  • Authorization
    Bearer YOUR_ACCESS_TOKEN Planned
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
addressstringAddress belonging to this wallet.Yes
transfer-keystringRequired without an access token.No
curl --request GET "https://coinkun.com/api/v1/wallets/${WALLET_ID}/addresses/${ADDRESS}/callback-log" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}"

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

Coinkun API v1 · Reviewed against this checkout
Contract reference: Apirone documentation. Adapted for Coinkun; implementation status is shown above.

Type to search the documentation

↑ ↓ navigate openesc closeLocal search · No data sent