API Reference

The SpectroCoin API is structured around REST. It features predictable resource-oriented URLs, accepts form-encoded request bodies, provides JSON-encoded responses, and employs standard HTTP response codes, authentication, and verbs.

Please note that the SpectroCoin API does not support bulk updates. Each request can only process one object.

To ensure optimal performance and reliability, SpectroCoin has implemented rate limits and allocations for API endpoints.

📘

Quick navigation.

To quickly jump to any endpoint in the API reference, simply use the shortcut Ctrl + / (on Windows/Linux) or Command + / (on macOS).

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. Read our API upgrades guide to learn more about backwards compatibility. For all API updates, view our API changelog.

All requests use your account API settings unless you override the API version. The upgrades guide lists every available version.

Scopes

Scope

Description

account:read

View account details:

  • Get account list.
  • Get single account info.

deposit:read

View deposits:

  • Get deposit addresses

deposit-crypto-address:read

View crypto deposit addresses. Allows reading of cryptocurrency deposit addresses associated with the user's account.

deposit-crypto-address:create

Generate new crypto deposit addresses. Permits the creation of new cryptocurrency deposit addresses.

exchange:read

View currency exchanges:

  • Get exchange history.
  • Get single exchange info.
  • Get exchange pairs.

exchange:create

Create currency exchanges:

  • Get exchange rate for the selected pair.
  • Calculate pay amount.
  • Calculate receive amount.
  • Execute currency exchanges.

withdraw-crypto:read

View crypto withdrawals:

  • Get crypto withdrawal details.
  • Get crypto withdrawals history.

withdraw-crypto:create

Create crypto withdrawals:

  • Create operation.
  • Get fee information.

withdraw-bank:read

View bank withdrawals. Grants permission to view bank withdrawal transactions and related information.

withdraw-bank:create

Create bank withdrawals. Allows the setup or initiation of bank withdrawal requests.

withdraw-with-exchange:read

View withdraw with exchange transactions. Grants permission to view withdrawal-with-exchange transactions and related information.

withdraw-with-exchange:create

Create withdraw with exchange transactions. Allows the creation of withdraw-with-exchange transactions.

merchants-preorders:read

View merchant pre-orders. Permits viewing of merchant projects' preorders and related transactions.

merchants-preorders:create

Create merchant preorders. Allows the creation or initiation of preorder transactions for merchant projects.

merchants-orders:read

View merchant orders. Enables viewing of orders placed for merchant projects.

merchants-orders:create

Create merchant orders. Allows the creation of new orders for merchant projects.

merchants-orders:cancel

Cancel merchant orders. Grants permission to cancel existing orders.

account-transaction:read

View account transactions. Allows the viewing of the account transactions.

payment-method:read

View payment methods. Grants permission to view payment methods associated with the user.

merchants-projects:read

View merchant projects. Allows the viewing of merchant projects.

merchants-projects:create

Create merchant projects. Allows the creation of new merchant projects.

merchants-projects:write

Write to merchant projects. Allows writing to merchant projects.

merchants-orders:pay

Pay merchant orders. Allows payment for merchant orders.

merchants-orders:callback

Merchant orders callback. Allows the callback for merchant orders.

merchants-callbacks:read

View merchant callbacks. Allows the viewing of merchant callbacks.

merchants-transactions:read

View merchant transactions. Allows the viewing of merchant transactions.

deposit:create

Create fiat deposits. Allows the creation of new fiat deposit transactions.

deposit:read

View fiat deposits. Allows the viewing of fiat deposit transactions.

deposit-crypto:read

View crypto deposits. Allows the viewing of the cryptocurrency deposit transactions.

purchase-gift-card:read

View purchased gift cards. Allows the viewing of purchased gift cards.

purchase-gift-card:pay

Pay for gift card purchases. Allows payment for gift card purchases.

withdraw-voucher:read

View voucher withdrawals. Allows the viewing of voucher withdrawal transactions.

withdraw-voucher:create

Create voucher withdrawals. Allows the creation of new voucher withdrawal transactions.

withdraw-e-wallet:read

View e-wallet withdrawals. Allows the viewing of e-wallet withdrawal transactions.

withdraw-e-wallet:create

Create e-wallet withdrawals. Allows the creation of new e-wallet withdrawal transactions.