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)= 937e81878116673549260c1f174483a6e061d1e19d4f9ffda56decdd8b2a9182

  • curl command:
    (HMAC SHA256)
    [linux]$ curl -H "X-API-KEY: pjFBsaK1HJwQYjZQyy8heEnyyt2G4KyfvDF29lMP" -H "X-API-SIGN: 937e81878116673549260c1f174483a6e061d1e19d4f9ffda56decdd8b2a9182" -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
required
number

Status code. 0 – OK, else error

msg
required
string

Status message

data
required
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.
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
required
string

currency code

name
required
string

currency name

alias
required
string

currency alias for wallets and qr codes

type
required
string

currency type

color
required
string

currency color

min
required
number

minimal amount allowed on this currency transaction.

max
required
number

maximum amount allowed on this currency transaction.

reserve
required
number

total currency reserve (how much currency is available for exchange)

precision
required
number

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

cent
required
number

the cost of one cent in this currency

active
required
boolean

currency available or unavailable for exchange

Get Pair

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

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

Parameters

from

From currency

Example: ETH.
string
to

To currency

Example: BTC.
string

Response

from
required
object

Information about the currency you want to exchange

currency
required
string

currency code

max
required
number

maximum possible amount for exchange

min
required
number

minimal possible amount for exchange

precision
required
number

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

rate
required
number

currency exchange rate

to
required
object

information about the currency to which you want to exchange

currency
required
string

currency code

max
required
number

maximum amount of currency available for exchange

min
required
number

minimum amount of currency available for exchange

precision
required
number

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

rate
required
number

Exchange rate for reverse exchange

Get Price

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

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

Parameters

from

From currency

Example: ETH.
string
to

To currency

Example: BTC.
string
amount

amount

Example: 0.001.
string

Response

error
required
number

price receipt error code

from
required
object

Information about the currency you want to exchange

amount
required
number

the amount you want to exchange

currency
required
string

currency code

max
required
number

maximum possible amount for exchange

min
required
number

minimal possible amount for exchange

precision
required
number

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

rate
required
number

currency exchange rate

usd
required
number

amount in USD

to
required
object

information about the currency to which you want to exchange

amount
required
number

amount of currency that is sent to the user.

currency
required
string

currency code

max
required
number

maximum amount of currency available for exchange

min
required
number

minimum amount of currency available for exchange

precision
required
number

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

rate
required
number

Exchange rate for reverse exchange

Get Order

Receiving information about the order.

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

Parameters

id

Order ID

Example: DCA4BA.
string

Response

id
required
string

order id

type
required
string

order type

step
required
string

order step

from
required
object

currency information for exchange

address
required
string

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

alias
required
string

currency alias for wallets and qr codes

currency
required
string

currency code

name
required
string

currency name

qty
required
number

amount of base currency which user sends.

tx
required
object

order transactions.

id
required
string

transaction ID in blockchain

amount
required
number

transaction amount

confirmations
required
number

transaction confirmations

fee
required
number

transaction fee

time
required
timestamp

time of transaction creation

to
required
object

Information for the currency to be exchanged

currency
required
string

currency code

name
required
string

currency name

alias
required
string

currency alias for wallets and qr codes

qty
required
string

amount of currency that is sent to the user

address
required
string

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

tx
required
string

order transactions

emergency
required
object

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

amount
required
number

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

choice
required
string

he choice of the option to continue the order in case of an emergency (out of 3)

currency
required
string

currency code

name
required
string

currency name

status
required
string

emergency order status

tx
required
string

emergency order transaction

rate
required
number

exchange rate

rateRev
required
number

Exchange rate for reverse exchange

status
required
string

order status

email
required
string

email address to subscribe for updates

reg
required
timestamp

time of order creation

start
required
timestamp

receive time

finish
required
timestamp

order execution time

update
required
timestamp

time of the last transaction update

expiration
required
timestamp

allowable time to pay for the order

left
required
number

the number of seconds left to pay the order

Create Order

Creating exchange orders.

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

Parameters

fromCurrency

currency code which user sends

Example: ETH.
string
toCurrency

currency code that is sent to the user

Example: BTC.
string
fromQty

amount of base currency which user sends

Example: 0.08.
number
toQty

amount of currency that is sent to the user

Example: 0.0025.
number
toAddress

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

Example: 1NdCTQ1ufXCZp6CHhDJGNvHpGztoYxWWhb.
string
type

order type: fixed or float

Example: fixed.
string

Response

id
required
string

order id

type
required
string

order type

step
required
string

order step

from
required
object

currency information for exchange

address
required
string

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

alias
required
string

currency alias for wallets and qr codes

currency
required
string

currency code

name
required
string

currency name

qty
required
number

amount of base currency which user sends.

to
required
object

Information for the currency to be exchanged

address
required
string

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

alias
required
string

currency alias for wallets and qr codes

currency
required
string

currency code

name
required
string

currency name

qty
required
string

amount of currency that is sent to the user

rate
required
number

exchange rate

rateRev
required
number

Exchange rate for reverse exchange

status
required
string

order status

email
required
string

email address to subscribe for updates

reg
required
timestamp

time of order creation

expiration
required
timestamp

allowable time to pay for the order

left
required
number

the number of seconds left to pay the order