API FixedFloat

Introduction

The FixedFloat API allows you to automate the receipt of information about the exchange rates of currencies, created orders, presented on the FixedFloat service, create orders and manage them using it.

API KEY and SECRET KEY are required to access the API methods.

Getting the API key

To release a token, follow these steps:

  • Open the page https://fixedfloat.com/apikey
  • Enter your E-mail, if you want to receive notifications about changes in the API
  • Confirm reCAPTCHA
  • Click "Generate"
  • Wait 60 seconds
  • Copy API KEY and SECRET KEY and save in a safe place. Use this data to query the FixedFloat API.

Request Authorization and API call example

The resulting API KEY should be sent in the X-API-KEY header with each API call. An additional parameter signature in the X-API-SIGN header is also required.

To get the signature parameter, you must use your SECRET KEY as the HMAC SHA256 operation key and totalParams as its value.

totalParams is defined as the query string concatenated with the request body

Example:

  • queryString:

    from=ETH&to=BTC

  • HMAC SHA256 signature:
    [linux]$ echo -n "from=ETH&to=BTC" | openssl dgst -sha256 -hmac "qVeyDheFpFavNy8kSy1vJc9SG8FZnFeWnJDf9ACx"
(stdin)= a25b61d23c4811ead7738c2124a6d06ebb4b8a4d695da46a2ad8965553d09333

  • curl command:
    [linux]$ curl -H "X-API-KEY: pjFBsaK1HJwQYjZQyy8heEnyyt2G4KyfvDF29lMP" -H "X-API-SIGN: a25b61d23c4811ead7738c2124a6d06ebb4b8a4d695da46a2ad8965553d09333" -d "from=ETH&to=BTC" -X POST https://fixedfloat.com/api/v1/getPair

API for crypto currency exchange. All methods have the response structure:

code
number

Status code. 0 – OK, else error

msg
string

Status message

data
object

Data response

List of methods

All methods

Get Currencies Getting a list of all currencies that are available on FixedFloat.com.
Get Pair Information on currency pairs: rates, amount of currency available for exchange.
Get Price Information about a currency pair with a set amount of funds.
Get Order Receiving information about the order.
Set emergency Emergency Action Choice
Create Order Creating exchange orders.

Get Currencies

Getting a list of all currencies that are available on FixedFloat.com.

GET https://fixedfloat.com/api/v1/getCurrencies

Response

array

object
currency
string

currency code

symbol
string

currency symbol

name
string

currency name

alias
string

currency alias for wallets and qr codes

type
string

currency type

color
string

currency color

precision
number

the number of digits after the decimal point, which determines the minimum unit of this currency

send
boolean

currency available or unavailable for sending in exchange

recv
boolean

currency available or unavailable for receiving in exchange

Get Pair

Information on currency pairs: rates, amount of currency available for exchange.

POST https://fixedfloat.com/api/v1/getPair

Parameters

from
required

From currency

Example: ETH.
string
to
required

To currency

Example: BTC.
string
amount
optional

amount

Example: 0.001.
number

Response

max
number

maximum amount of currency available for exchange

min
number

minimum amount of currency available for exchange

rate
number

currency exchange rate

amount
number

amount

Get Price

Information about a currency pair with a set amount of funds.

POST https://fixedfloat.com/api/v1/getPrice

Parameters

fromCurrency
required

From currency

Example: ETH.
string
fromQty
optional

amount

Example: 0.001.
number
toCurrency
required

To currency

Example: BTC.
string
toQty
optional

amount

Example: 0.001.
number
type
required

order type: fixed or float

Example: fixed.
string

Response

error
number

price receipt error code

from
object

Information about the currency you want to exchange

amount
number

the amount you want to exchange

currency
string

currency code

max
number

maximum possible amount for exchange

min
number

minimal possible amount for exchange

precision
number

the number of digits after the decimal point, which determines the minimum unit of this currency

rate
number

currency exchange rate

usd
number

amount in USD

to
object

information about the currency to which you want to exchange

amount
number

amount of currency that is sent to the user.

currency
string

currency code

max
number

maximum amount of currency available for exchange

min
number

minimum amount of currency available for exchange

precision
number

the number of digits after the decimal point, which determines the minimum unit of this currency

rate
number

Exchange rate for reverse exchange

Get Order

Receiving information about the order.

GET https://fixedfloat.com/api/v1/getOrder

Parameters

id
required

Order ID

Example: 5VSKHM.
string
token
required

Security token of order

Example: YQR2XrznWkuVHsAiBSQeAnI4t0EQGj1HElYFlF2O.
string

Response

id
string

order id

type
string

order type

step
string

order step

from
object

currency information for exchange

address
string

the destination address to which the user is ought to deposit his funds in order for the trade to execute.

extra
string

MEMO or Destination Tag if required

alias
string

currency alias for wallets and qr codes

currency
string

currency code

name
string

currency name

qty
number

amount of base currency which user sends.

tx
object

order transactions.

id
string

transaction ID in blockchain

amount
number

transaction amount

confirmations
number

transaction confirmations

fee
number

transaction fee

time
timestamp

time of transaction creation

to
object

Information for the currency to be exchanged

currency
string

currency code

name
string

currency name

alias
string

currency alias for wallets and qr codes

qty
string

amount of currency that is sent to the user

address
string

a destination address to which the funds will be dispatched upon the successful completion of the Order. If MEMO or Destination Tag was specified, then it will be added to this field separated by a colon

tx
string

order transactions

emergency
object

emergency information (if the user sent later, less, more currency, etc.)

status
array

emergency order status. Types of statuses:

  • EXPIRED — Transaction arrived after order expired
  • LESS — The transaction was received with a lower amount than the order was created. Applies to fixed orders and over-limit amounts
  • MORE — The transaction was received with a larger amount than the order was created. Applies to fixed orders and over-limit amounts
  • LIMIT — The amount received exceeds the maximum limit or less than the minimum.
  • IMPOSSIBLE — The market rate has changed by more than 1.2% before the appearance of transaction on the blockchain network

choice
string

choice of the option to continue the order in case of an emergency

  • EXCHANGE — Continue exchange at the current market rate
  • REFUND — Refund your order minus the network fee

repeat
string

If the value is 1, then several transactions have been sent to this address. This could mean a transaction for Replace By Fee or a resend. You need to contact technical support to resolve the issue.

amount
number

The amount of currency that occurs when the user has sent more or less than the currency specified in the order.

currency
string

currency code

name
string

currency name

tx
string

emergency order transaction

rate
number

exchange rate

rateRev
number

Exchange rate for reverse exchange

status
string

order status

  • 0 — New order, transaction expected
  • 1 — The transaction is waiting for the required number of confirmations.
  • 2 — Currency exchange (usually lasts a split second)
  • 3 — Sending funds (usually lasts a split second)
  • 4 — Order completed
  • 5 — Order expired
  • 6 — Not currently in use
  • 7 — A decision must be made to proceed with the order

email
string

email address to subscribe for updates

reg
timestamp

time of order creation

start
timestamp

receive time

finish
timestamp

order execution time

update
timestamp

time of the last transaction update

expiration
timestamp

allowable time to pay for the order

left
number

the number of seconds left to pay the order

Set emergency

Emergency Action Choice

GET https://fixedfloat.com/api/v1/setEmergency

Parameters

id
required

Order ID

Example: 5VSKHM.
string
token
required

Security token of order

Example: YQR2XrznWkuVHsAiBSQeAnI4t0EQGj1HElYFlF2O.
string
choice
required

EXCHANGE or REFUND

Example: EXCHANGE.
string
address
optional

refund address, required if choice="REFUND"

Example: 0x4e5b2e1dc63f6b91cb6cd759936495434c7e972f.
string

Response

boolean

TRUE if successful

Create Order

Creating exchange orders.

POST https://fixedfloat.com/api/v1/createOrder

Parameters

fromCurrency
required

currency code which user sends

Example: ETH.
string
toCurrency
required

currency code that is sent to the user

Example: BTC.
string
fromQty
optional

amount of base currency which user sends

Example: 0.08.
number
toQty
optional

amount of currency that is sent to the user

Example: 0.0025.
number
toAddress
required

a destination address to which the funds will be dispatched upon the successful completion of the Order

Example: 1NdCTQ1ufXCZp6CHhDJGNvHpGztoYxWWhb.
string
extra
optional

if you need to specify a Memo or Destination Tag when sending, you should specify it here. This parameter can be omitted by specifying the MEMO or Destination Tag in toAddress separated by a colon.

Example: 54132.
string
type
required

order type: fixed or float

Example: fixed.
string

Response

id
string

order id

token
string

security token with which you can receive and manage order information.

type
string

order type

step
string

order step

from
object

currency information for exchange

address
string

the destination address to which the user is ought to deposit his funds in order for the trade to execute.

extra
string

MEMO or Destination Tag if required

alias
string

currency alias for wallets and qr codes

currency
string

currency code

name
string

currency name

qty
number

amount of base currency which user sends.

to
object

Information for the currency to be exchanged

address
string

a destination address to which the funds will be dispatched upon the successful completion of the Order. If MEMO or Destination Tag was specified, then it will be added to this field separated by a colon

alias
string

currency alias for wallets and qr codes

currency
string

currency code

name
string

currency name

qty
string

amount of currency that is sent to the user

rate
number

exchange rate

rateRev
number

Exchange rate for reverse exchange

status
string

order status

email
string

email address to subscribe for updates

reg
timestamp

time of order creation

expiration
timestamp

allowable time to pay for the order

left
number

the number of seconds left to pay the order