Skip to content
coinkun docs
Coinkun home Dashboard

API REFERENCE v1

Account

Create accounts and addresses, read balances and receipt/payment history, send owned Litecoin transfers and configure callbacks.

On this page

#Create Account

Available

Create an anonymous Coinkun account and receive its Transfer Key once. No authentication is required.

POST/accounts

Request

  • HTTP MethodPOST
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts

No request parameters.

curl --request POST "https://coinkun.com/api/v1/accounts" \
  --header 'Content-Type: application/json' \
  --data '{}'

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

#Account Info

Available

Read public Account metadata without a Transfer Key. Only existing Litecoin currency data is returned; reading never creates keys or contacts a node.

GET/accounts/{account}

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}
ParameterTypeDescriptionRequired
accountstringAccount identifier in the URL.Yes
currencystringThe only supported value is ltc (Litecoin); other values are rejected.No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}" \
  --get \
  --data-urlencode "currency=ltc"

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

#Account Balance

Available

Read this Account's verified Litecoin balance without a Transfer Key. Amounts use integer atomic units, not decimal LTC values.

GET/accounts/{account}/balance

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/balance
ParameterTypeDescriptionRequired
accountstringAccount identifier.Yes
currencystringOnly ltc (Litecoin). Optional for the whole Account, required with addresses.No
addressesstring1 to 100 comma-separated owned receiving addresses. Duplicates count once; currency=ltc is required.No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/balance" \
  --get \
  --data-urlencode "currency=ltc"

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

#Generate Address

Available

Issue a new receiving address for the Account in the URL. API and dashboard share the same public keyset, receive counter and saved addresses. No Transfer Key, private source or Core wallet is needed for issuance.

POST/accounts/{account}/addresses

Request

  • HTTP MethodPOST
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/addresses
ParameterTypeDescriptionRequired
accountstringAccount identifier in the URL.Yes
currencystringRequired JSON field; only ltc (Litecoin) is supported.Yes
addr-typestringOptional JSON field; defaults to p2wpkh. Other values, including null, are rejected.No
callbackobject or nullOptional URL/method/data override. Omitted or null inherits the account setting; an empty object disables notifications for this address.No
curl --request POST "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/addresses" \
  --header 'Content-Type: application/json' \
  --data '{
  "currency": "ltc",
  "addr-type": "p2wpkh"
}'

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

#Address Info

Available

Read the saved metadata and verified balance of one receiving address belonging to this Account. No Transfer Key or key derivation is needed; balance verification requires node evidence.

GET/accounts/{account}/addresses/{address}

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/addresses/{address}
ParameterTypeDescriptionRequired
accountstringOwning account identifier.Yes
addressstringReceiving address within that account.Yes
currencystringOptional; only ltc (Litecoin) is supported.No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/addresses/${ADDRESS}" \
  --get \
  --data-urlencode "currency=ltc"

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

#Address Balance

Available

Read the verified integer balance of one receiving address belonging to the Account, without a Transfer Key.

GET/accounts/{account}/addresses/{address}/balance

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/addresses/{address}/balance
ParameterTypeDescriptionRequired
accountstringOwning account identifier.Yes
addressstringReceiving address.Yes
currencystringOptional; only ltc (Litecoin) is supported.No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/addresses/${ADDRESS}/balance" \
  --get \
  --data-urlencode "currency=ltc"

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

#Account Addresses

Available

Read saved Litecoin receiving addresses with a verified balance per entry, newest first, with pagination and optional prefix and empty-balance filters.

GET/accounts/{account}/addresses

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/addresses
ParameterTypeDescriptionRequired
accountstringAccount identifier.Yes
currencystringRequired query parameter; only ltc (Litecoin) is supported.Yes
limitintegerInteger from 1 to 100; default 10. Invalid values are rejected, not clamped.No
offsetintegerInteger from 0 to 10000; default 0. Number of matching records to skip.No
qstringCase-sensitive address:prefix (1–90 ASCII letters or digits) and/or empty:false. The latter excludes zero total balances, not zero available balances. Combine once each with a comma in either order; empty q means no filter. Wildcards, duplicate filters and other empty values are rejected.No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/addresses" \
  --get \
  --data-urlencode "currency=ltc" \
  --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

Available

Read-only Litecoin transfer preview using verified owned funds. It does not reserve, sign or publish.

GET/accounts/{account}/transfer

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/transfer
ParameterTypeDescriptionRequired
accountstringSource account identifier.Yes
currencystringAsset to estimate.Yes
destinationsstringOne address:amount pair; amount is positive integer atomic units. Percentages and multiple destinations follow in step 6.7.Yes
addressesstringRestrict the source to comma-separated account addresses.No
feestringStrategy normal, priority or custom. Custom requires fee-rate in integer atomic units per virtual byte.No
fee-rateintegerPositive integer atomic units per virtual byte; only with fee=custom.No
subtract-fee-from-amountbooleanDeduct the network fee proportionally from recipient amounts. Required for a 100% sweep. Net outputs must not become dust.No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/transfer" \
  --get \
  --data-urlencode "currency=ltc" \
  --data-urlencode "destinations=YOUR_DESTINATION_ADDRESS:100000"

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

#Transfer

Available

Authenticated durable Litecoin payment on the selected network. Only the Account's verified outputs fund its payment, fee and change. Mainnet requires COINKUN_LTC_MAINNET_SPENDING_ENABLED=true; default is disabled. A pause preserves signed holds and permits observation and callbacks through separately enabled workers. Offline mainnet tests are not live acceptance.

POST/accounts/{account}/transfer

Request

  • HTTP MethodPOST
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/transfer
  • Authorization
    transfer-key in the JSON body. JWT remains planned.
  • Idempotency-KeyYOUR_UNIQUE_ORDER_KEY
ParameterTypeDescriptionRequired
accountstringSource account identifier.Yes
currencystringAsset to transfer.Yes
transfer-keystringActive Transfer Key for this Account. JWT is not supported in this MVP.Yes
Idempotency-KeyheaderCoinkun retry contract; 1..128 ASCII letters, digits, underscore, dot, colon or dash. Same key plus changed intent returns 409.Yes
fee-limitintegerCoinkun safety extension; maximum approved network fee in atomic units. A larger fresh estimate is rejected without signing.Yes
destinationsarray1..100 ordered distinct transparent recipients on the selected network. Integer atomic amounts (integer strings accepted) or percentages of verified available source funds before fees, up to eight decimal places. Fixed amounts are additional; percentage sum is at most 100%. Largest-remainder rounding is deterministic in recipient order.Yes
addressesarrayOptional subset of source receiving addresses.No
feestringNetwork fee strategy.No
fee-rateintegerRequired only for custom, in integer atomic units per virtual byte.No
subtract-fee-from-amountbooleanSubtract the network fee proportionally, with exact integer largest-remainder rounding. Net outputs must remain non-dust.No
curl --request POST "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/transfer" \
  --header 'Idempotency-Key: YOUR_UNIQUE_ORDER_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "currency": "ltc",
  "transfer-key": "YOUR_TRANSFER_KEY",
  "fee-limit": 1000,
  "destinations": [
    {
      "address": "YOUR_DESTINATION_ADDRESS",
      "amount": 100000
    }
  ],
  "fee": "normal",
  "subtract-fee-from-amount": false
}'

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

#Account History

Available

Read Litecoin receipts and accepted payments for this Account, not a balance. One combined page and total; confirmation is checked against the scanner checkpoint and node.

GET/accounts/{account}/history

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/history
ParameterTypeDescriptionRequired
accountstringAccount identifier.Yes
currencystringThe only supported value is ltc (Litecoin).No
qstringUp to 1024 ASCII bytes. Comma-separated address, date-from, date-to and item-type (receipt or payment); each filter appears at most once.No
limitintegerInteger from 1 to 100; default 10.No
offsetintegerInteger from 0 to 10000; default 0.No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/history" \
  --get \
  --data-urlencode "currency=ltc" \
  --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.

#Account History Item

Available

Read one owned Litecoin receipt with receiving outputs, or an accepted payment with destinations and saved fees.

GET/accounts/{account}/history/{HistoryItemID}

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/history/{HistoryItemID}
ParameterTypeDescriptionRequired
accountstringAccount identifier.Yes
HistoryItemIDstringReceipt txid (64 lowercase hex characters) or payment ID (pay- followed by 32 lowercase hex characters).Yes
currencystringThe only supported value is ltc (Litecoin).No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/history/${HISTORY_ITEM_ID}" \
  --get \
  --data-urlencode "currency=ltc"

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

#Account Address History

Available

Saved incoming and outgoing blockchain movements of one exact LTC receiving address.

GET/accounts/{account}/addresses/{address}/history

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/addresses/{address}/history
ParameterTypeDescriptionRequired
accountstringOwning account identifier.Yes
addressstringExact Account-owned receiving address; foreign, change and unknown addresses return 404.Yes
currencystringOptional ltc only; uses the selected regtest/mainnet network.No
limitintegerCanonical integer 1..100; default 10 transactions, not outputs.No
offsetintegerCanonical integer 0..10000; default 0.No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/addresses/${ADDRESS}/history" \
  --get \
  --data-urlencode "currency=ltc" \
  --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.

#Account Callback Info

Available

Read the saved notification configuration for the LTC account. No RPC or delivery occurs.

GET/accounts/{account}/callback

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/callback
  • Authorization
    transfer-key in the JSON body. JWT remains planned.
ParameterTypeDescriptionRequired
accountstringAccount identifier.Yes
currencystringMust be ltc on the selected network.Yes
transfer-keystringTransfer Key of this account. JWT is not implemented.Yes
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/callback" \
  --get \
  --data-urlencode "currency=ltc"

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

#Address Callback Info

Available

Read the effective receiving-address callback (own override or account default). Null inherits; an empty object disables notifications. Public metadata never exposes callback secrets.

GET/accounts/{account}/addresses/{address}/callback

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/addresses/{address}/callback
  • Authorization
    transfer-key in the JSON body. JWT remains planned.
ParameterTypeDescriptionRequired
accountstringOwning account identifier.Yes
addressstringReceiving address.Yes
transfer-keystringTransfer Key of this account. JWT is not implemented.Yes
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/addresses/${ADDRESS}/callback"

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

#Address Callback Log

Available

Read real delivery attempts for an owned receiving address. This private journal never calls RPC, sends HTTP or creates an attempt.

GET/accounts/{account}/addresses/{address}/callback-log

Request

  • HTTP MethodGET
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}/addresses/{address}/callback-log
  • Authorization
    transfer-key in the JSON body. JWT remains planned.
ParameterTypeDescriptionRequired
accountstringOwning account identifier.Yes
addressstringReceiving address.Yes
transfer-keystringTransfer Key of this account; JWT is deferred.Yes
limitintegerPage size 1..100; default 10.No
offsetintegerNumber of attempts to skip, 0..10000; default 0.No
curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/addresses/${ADDRESS}/callback-log" \
  --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.

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