NAV Navbar
json
  • Introduction
  • Login
  • Logout
  • User Registration
  • Secondary Market
  • Symbols
  • Blockchain
  • Ethereum Entry Point
  • Common Responses
  • FAQ
  • Introduction

    Fundamental Interactions (FI) API is available on FI Platform. All endpoints follow the URL:

    http://dbot-dev.fi-edition.com/api/v2/*

    If you have any question please read FAQ

    Login

    Get User API Hash

    User hash by email and password.

    Request Data:

    {
       "e": "user1@text.com",
       "p": "Password123"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/hash/get

    Request Parameters

    Parameter Default Description
    email String User Email
    password String User Password

    Response Error

    Response Data:

    {
      "message":          "Unknown email/password combination",
      "success":          false,
      "operations_count": 4
      "data": {
          "hash":         nil
      }
    }
    

    {message: "Unknown email/password combination", success: false, operations_count: 12, data: {hash: nil}}

    Response Error Messages

    Parameter Type Text
    message String Something went wrong. Try again later.
    message String Please, pass correct parameters.
    message String Unknown email/password combination
    message String Email verification is required.
    message String Your account is no longer active.
    message String Your account is %{status} ("Suspended" for example)
    message String You are not able to use API. Please, contact the administrator.
    message String Your Password was changed by Admin, please contact Admin to solve this issue

    Response Data:

    {
      "message":             "Success.",
      "success":             true,
      "operations_count":    5,
      "data": {
        "hash":              "sdlcksueirpfm"
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 5, data: {hash: "sdlcksueirpfm"}}

    Description of operations_count

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Quantity of today's operations
    data Array User Datum

    Logout

    Sign Out

    Make current token is inaccessible.

    Request Data:

    {
      "hash":       "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/account/sign_out

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Response Error

    Response Data:

    {
      "message":          "No such hash",
      "success":          false,
      "operations_count": 4
      "data": {}
    }
    

    {message: "No such hash", success: false, operations_count: 12, data: {hash: nil}}

    Response Error Messages

    Parameter Type Text
    message String Something went wrong. Try again later.
    message String Error! No hash..
    message String Error! Too much operations today. Try again tomorrow.
    message String Error! No such hash.
    message String Error! Hash has been expired
    message String Error! API was disabled.
    message String Error! Email not verified.
    message String Error! User is not approved by administrator.
    message String Error! User is not associated with any firm.

    Response Data:

    {
      "message":             "Success.",
      "success":             true,
      "operations_count":    5,
      "data": {}
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 5, data: {}}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Quantity of today's operations
    data Array {}

    User Registration

    Info

    Get current user information

    Request Data:

    {
      "hash":       "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/account/info

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Response Data:

    {
      "message":          "Success.",
      "success":          true,
      "data": {
        "contact_information" : {
            "first":                "identity",
            "last":                 "mind",
            "firm":                 "MainTestFirm",
            "role":                 "OTC Crypto Trader",
            "trader_id":            "otcCrypt",
            "phone":                "",
            "email":                "fidevalex+identitymind@gmail.com",
            "address":              "",
            "citizenship":          "",
            "dob":                  "",
            "ssn":                  "",
            "accredited_investor":  "N/A"
        }
      }
      "operations_count": 6
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 6, data: {contact_information:[]}}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Account data

    Create

    Create new user.
    When you create a new user you have to:
    1. Complete your email verification.
    2. Wait until Administrator approve your user. This may take a time.

    List of user roles you can get here http://dbot-dev.fi-edition.com/api/v2#list-of-user-roles

    Request Data:

    {
       "email":               "fidevalex+dbot802@gmail.com",
       "password":            "Qwerty123",
       "city":                "Chicago",
       "ssn":                 "36451264",
       "first_name":          "Dev",
       "last_name":           "Alex",
       "address":             "Main Address",
       "zip":                 "26YTR",
       "phone":               "+1 234-56-99",
       "regulator":           "Reserve Bank of America",
       "nature_of_business":  "Insurance Company",
       "firm_name":           "Firm Sun and Co.",
       "trader_id":           "FJYHB",
       "role_id":             4
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/users/new

    Request Parameters

    Parameter Default Description
    email String User Email
    password String User Password
    city String City
    ssn String Social Security Number
    first_name String First Name
    last_name String Last Name
    address String User Address
    zip String ZIP Code
    phone String User Phone
    regulator String Regulator
    nature_of_business String Nature of Business
    firm_name String Suggested Firm Name
    trader_id String User Trader ID
    role_id Integer User Role ID

    Response Data:

    {
      "message":           "Fail to create new user",
      "success":           false,
      "operations_count":  1,
      "errors":            errors
    }
    

    Response Error

    {message: "Fail to create new user", success: false, operations_count: 1, errors: errors}

    Description of operations_count

    {
      "message":           "Success.",
      "success":           true,
      "operations_count":  2,
      "data": {
         "id":        738
       }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 2, "data": {"id": 738}}

    Description of operations_count

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Quantity of today's operations
    id Integer User ID

    Get User Status

    User status by user id.
    You received user id in response answer while user creation.

    Request Data:

    {
       "id": 738
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/users/status/get

    Request Parameters

    Parameter Default Description
    id Integer User ID

    Response Data:

    {
      "message":             "Success.",
      "success":             true,
      "operations_count":    3,
      "data": {
        status_id:           1,
        status_name:         "Approved",
        email_verified:      true,
        email_verified_name: "Email Verified"
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 3, data: {status_id: 1, status_name: "Approved", email_verified: true, email_verified_name: "Email Verified"}}

    Description of operations_count

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Quantity of today's operations
    data Array User Status Data

    List of User Roles

    List of Roles for user creation.

    Request Data:

    {
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/users/roles/get

    Request Parameters

    Parameter Default Description

    Response Data:

    {
      "message":           "Fail to get user roles. Try again later.",
      "success":           false,
      "operations_count":  4,
      "data":              nil
    }
    

    Response Error

    {message: "Fail to get user roles. Try again later.", success: false, operations_count: 4, data: nil}

    Description of operations_count

    {
      "message":             "Success.",
      "success":             true,
      "operations_count":    5,
      "data": [
        {"role_id": 0, "role_name": "Trader. Sponsored Buy Side"},
        {"role_id": 1, "role_name": "Issuer"},
        {"role_id": 2, "role_name": "Investor"},
        {"role_id": 3, "role_name": "Trader. Market Maker"},
        {"role_id": 4, "role_name": "Trader. Retail"},
        {"role_id": 5, "role_name": "Trader. Vendor"},
        {"role_id": 6, "role_name": "Sponsor"},
        {"role_id": 7, "role_name": "Crypto Trader"},
        {"role_id": 8, "role_name": "OTC Crypto Trader"}
      ]
    

    Response Success

    {message: "Success.", success: true, operations_count: 5, data: [{role_id: 0, role_name: "Trader. Sponsored Buy Side"},...,{role_id: 8, role_name: "OTC Crypto Trader"}]}

    Description of operations_count

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Quantity of today's operations
    data Array User Roles

    Verification Center. Level 2

    User Verification for Level 2.

    Send the Documents.

    Request Data:

    
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/account/verify

    Request Parameters

    Send data as Form. multipart/form-data

    Parameter Default Description
    hash String Hash
    res_doc file Passport photo
    res_doc file Valid Government Issued ID

    Response Data:

    {
      "message":             "Success.",
      "success":             true,
      "operations_count":    5,
      "data": { }
    }
    

    Response

    {message: "Success.", success: true, operations_count: 5, data: []}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Quantity of today's operations
    data Array User Datum

    Secondary Market

    New Order Send

    Request Data:

    {
      "hash":       "eqav6crwfusl3g072otxhzmb9",
      "page_code":  "fdml.b",
      "quantity":   10,
      "display":    "",
      "price":      7500,
      "side":       "B",
      "tif":        0,
      "dest":       "DBOX",
      "type":       1,
      "capacity":   0
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/participate

    Request Parameters

    Parameter Default Description Possible Values
    hash String Hash-code
    page_code String Symbol Pair Code 'code' from "List of symbol-pairs"
    quantity String Order Quantity any numerical digits
    display String Order displayQty "" or numerical digits
    price String Order Price any numerical digits
    side String Order Side "B" or "S" (Buy/Sell)
    type String Order type "1" OR "0" (limit/Market)
    tif String Order TIF "0" or "4" (Day/IOC)
    capacity String Order capacity "0" or "1" or "6" or "12"
    (Agency/Principal/ShortExemptL/Riskless)
    dest String Order dest "DBOX" only

    Response Data:

    {
      "message":          "Success.",
      "success":          true,
      "data": {
        "order_queue" : {
            "security":         "deFDML.B",
            "side":             "B",
            "category":         "1000",
            "price":            7500.0,
            "actionType":       "0",
            "execQty":          "100000",
            "fractionBase":     10000,
            "clientRef1":       "TRADER.28.714.1.9024.de",
            "clientRef2":       0,
            "stringCurrency":   "USD",
            "customTag1":       "",
            "customTag2":       7500.0,
            "displayQty":       "100000",
            "orderType":        1,
            "orderFlags":       0,
            "trader":           "otcCrypt",
            "orderCapacity":    "0",
            "firm":             "FUND",
            "account":          "",
            "tif":              "0",
            "actDest":          "DBOX",
            "status":           "Pending"
        },
        "record_id": 9024
    
      }
      "operations_count": 1
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 1}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today

    Response Error

    {message: "Value '0' for param 'type' does not supported ", success: false, operations_count: 4, data: nil}

    {
      "message":          "Value '0' for param 'type' does not supported",
      "success":          false,
      "operations_count": 4
      "data": nil
    }
    

    {message: "Price can not be empty", success: false, operations_count: 5, data: nil}

    {
      "message":          "Price can not be empty",
      "success":          false,
      "operations_count": 5
      "data": nil
    }
    

    Cancel Order

    Request Data:

    {
      "hash":   "eqav6crwfusl3g072otxhzmb9",
      "ref_no": "57MIPIXGU6D4C7"
    }
    
    {
      "hash":   "eqav6crwfusl3g072otxhzmb9",
      "record_id": "9024"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/order/cancel

    Request Parameters

    ParameterDefaultDescription
    hashStringHash-code
    ref_noStringOrder RefNo
    OR
    ParameterDefaultDescription
    hashStringHash-code
    record_idStringOrder Record Id

    Response Data:

    {
      "message":          "Param 'ref_no' or 'record_id' is empty. Fill please.",
      "success":          false,
      "operations_count": 12
      "data": nil
    }
    

    Response Error

    {message: "Param 'ref_no' or 'record_id' is empty. Fill please.", success: false, operations_count: 12, data: nil}

    {
      "message":          "Order not found.",
      "success":          false,
      "operations_count": 13
      "data": nil
    }
    

    Response Error

    {message: "Order not found.", success: false, operations_count: 13, data: nil}

    Response Data:

    {
      "message":          "Order set to cancel queue successfully.",
      "success":          true,
      "data": {}
      "operations_count": 1
    }
    

    Response Success

    {message: "Order set to cancel queue successfully.", success: true, operations_count: 1}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today

    List of Live Orders

    Request Data:

    {
      "hash": "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/live

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Response Data:

    {
      "message":          "Success.",
      "success":          true,
      "operations_count": 2,
      "data": {
        "live": [
          {
            "act_dest":            "DBOX"
            "entered":             1528293946318
            "exec_qty":            0
            "fraction_base":       1
            "order_capacity_name": "Agency"
            "orig_qty":            1
            "page_code":           "BTCUSD"
            "price":               "6970.0"
            "refno":               "57D4TL0Q07I0C7"
            "security_display":    "BTC/USD"
            "security_name":       "Bitcoin"
            "status":              "Open"
            "string_currency":     "USD"
            "blockchain_hash":     "0x14acdadab367772d196bc747fbb89908670a62f9887d4aa287dc18ada6b4f4dd"
            "tif":                 "GTT"
          },
          {...}
        ]
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 2, data: {live:[]}}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Live Orders Data

    List of Recent Orders

    Request Data:

    {
      "hash": "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/recent

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Response Data:

    {
      "message":          "Success.",
      "success":          true,
      "operations_count": 3,
      "data": {
        "recent": [
          {
            "act_dest":            "DBOX",
            "entered":             1528384176493,
            "exec_qty":            0,
            "fraction_base":       1,
            "order_capacity_name": "Agency",
            "orig_qty":            5,
            "page_code":           "btcusd",
            "price":               "6000.0",
            "refno":               "57E9HYBO0Q44C7",
            "security_display":    "BTCUSD",
            "security_name":       "Bitcoin",
            "status":              "Expired",
            "string_currency":     "USD",
            "blockchain_hash":     "0x14acdadab367772d196bc747fbb89908670a62f9887d4aa287dc18ada6b4f4dd",
            "tif":                 "GTT"
          },
          {...}
        ]
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 3, data: {recent:[]}}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Recent Orders Data

    List of Holdings

    Request Data:

    {
      "hash":   "eqav6crwfusl3g072otxhzmb9"
    }
    
    {
      "hash":   "eqav6crwfusl3g072otxhzmb9",
      "wallet": "0xba2eea98a2a17df6573a6c1e19f88ebf1cabc275"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/holdings

    Request Parameters

    ParameterDefaultDescription
    hashStringHash-code
    In this case system try to find default wallet
    OR
    ParameterDefaultDescription
    hashStringHash-code
    walletStringWallet

    Response Error

    Response Data:

    {
      "message":          "There is no default wallet. Set default or fill 'wallet' param",
      "success":          false,
      "operations_count": 12
      "data": nil
    }
    

    {message: "There is no default wallet. Set default or fill 'wallet' param", success: false, operations_count: 12, data: nil}

    Response Success

    {
      "message"     :"Success.",
      "success"     :true,
      "data": {
        "holdings":[
          {
            "token_name":       "Coin",
            "amount":           1156,
            "fraction_base":    1,
            "open_orders":      0,
            "frozen_amount":    0,
            "average":          0,
            "last_update":      ""
            },
          {...}
        ]
      },
      "operations_count":3
    }
    

    {"message"=>"Success.", "success"=>true, "data"=>{"holdings"=>[]}, "operations_count"=>3}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Holdings Data

    List of Transactions

    Request Data:

    {
      "hash":   "eqav6crwfusl3g072otxhzmb9"
    }
    
    {
      "hash":   "eqav6crwfusl3g072otxhzmb9",
      "wallet": "0xba2eea98a2a17df6573a6c1e19f88ebf1cabc275"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/transactions

    Request Parameters

    ParameterDefaultDescription
    hashStringHash-code
    In this case system try to find default wallet
    OR
    ParameterDefaultDescription
    hashStringHash-code
    walletStringWallet

    Response Data:

    {
      "message":          "There is no default wallet. Set default or fill 'wallet' param",
      "success":          false,
      "operations_count": 12
      "data": nil
    }
    

    Response Error

    {message: "There is no default wallet. Set default or fill 'wallet' param", success: false, operations_count: 12, data: nil}

    Response Success

    {
      "message"     :"Success.",
      "success"     :true,
      "data": {
        "transactions":[
          {
            "operation_hash":   "0x06b8f603aa4e65f0c7198272200c67825bb1bb2f01c2252ed9ef3c2dfe0108dc",
            "tokens":           "deTEST16",
            "currencies":       "-",
            "fees":             "-",
            "status":           "Fixed",
            "datetime":         "07/13/2018 10:08:20"
            },
          {...}
        ]
      },
      "operations_count":3
    }
    

    {"message"=>"Success.", "success"=>true, "data"=>{"transactions"=>[]}, "operations_count"=>3}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Transactions Data

    Order info by RefNo/RecordId

    Request Data:

    {
      "hash":   "eqav6crwfusl3g072otxhzmb9",
      "ref_no": "57MIPIXGU6D4C7"
    }
    
    {
      "hash":   "eqav6crwfusl3g072otxhzmb9",
      "record_id": "9024"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/order/info

    Request Parameters

    ParameterDefaultDescription
    hashStringHash-code
    ref_noStringOrder RefNo
    OR
    ParameterDefaultDescription
    hashStringHash-code
    record_idStringOrder Record Id

    Response Data:

    {
      "message":          "Param 'ref_no' or 'record_id' is empty. Fill please.",
      "success":          false,
      "operations_count": 12
      "data": nil
    }
    

    Response Error

    {message: "Param 'ref_no' or 'record_id' is empty. Fill please.", success: false, operations_count: 12, data: nil}

    {
      "message":          "Order not found.",
      "success":          false,
      "operations_count": 13
      "data": nil
    }
    

    Response Error

    {message: "Order not found.", success: false, operations_count: 13, data: nil}

    {
      "message":         "Success.",
      "success":          true,
      "operations_count": 18,
      "data": {
        "symbol":               "deEOSUSD",
        "firm":                 "Fundamental",
        "status":               "Filled",
        "date_time":            "06/17/2018 01:18:15",
        "quantity":             100,
        "price":                "15.0",
        "refno":                "57NOR043RWG7C7",
        "matched":              84,
        "currency":             "USD",
        "exchangeRef":          "N/A",
        "remaining":            16,
        "clearing_number":      "12362",
        "clearing_firm_name":   "ETC Clearing",
        "precision":            1,
        "blockchain_hash":      "N/A",
        "blockchain_block":     "N/A"
    
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 14, data: {"symbol":"deEOSUSD", "firm":"Fundamental", "status":"Filled", "date_time":"06/17/2018 01:18:15", "quantity":100, "price":"15.0", "refno":"57NOR043RWG7C7", "matched":84, "currency":"USD", "exchangeRef":"N/A", "remaining":16, "clearing_number":"12362", "clearing_firm_name":"ETC Clearing", "precision":1, "blockchain_hash":"N/A", "blockchain_block":"N/A"}}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Order Data

    Order history by RefNo/RecordId

    Request Data:

    {
      "hash":   "eqav6crwfusl3g072otxhzmb9",
      "ref_no": "57MIPIXGU6D4C7"
    }
    
    {
      "hash":   "eqav6crwfusl3g072otxhzmb9",
      "record_id": "9024"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/order/history

    Request Parameters

    ParameterDefaultDescription
    hashStringHash-code
    ref_noStringOrder RefNo
    OR
    ParameterDefaultDescription
    hashStringHash-code
    record_idStringOrder Record Id

    Response Data:

    {
      "message":          "Param 'ref_no' or 'record_id' is empty. Fill please.",
      "success":          false,
      "operations_count": 12
      "data": nil
    }
    

    Response Error

    {message: "Param 'ref_no' or 'record_id' is empty. Fill please.", success: false, operations_count: 12, data: nil}

    {
      "message":          "Order not found.",
      "success":          false,
      "operations_count": 13
      "data": nil
    }
    

    Response Error

    {message: "Order not found.", success: false, operations_count: 13, data: nil}

    {
      "message":         "Success.",
      "success":          true,
      "operations_count": 18,
      "data": [
        "06/17/2018 01:18:15 User   from Fundamental Open an Order Bid (15.0 USD/100) ",
        "06/22/2018 23:24:20 Order was Executed,  14.0 USD / 84, Filled 84.0%, B: Fundamental, S:Fundamental "
      ]
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 14, data: ["06/17/2018 01:18:15 User from Fundamental Open an Order Bid (15.0 USD/100) ", "06/22/2018 23:24:20, Order was Executed, 14.0 USD / 84, Filled 84.0%, B: Fundamental, S:Fundamental "]}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Order History Data

    Symbols

    List of symbols

    Request Data:

    {
      "hash": "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/symbols

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Response Data:

    {
      "message":            "Success.",
      "success":            true,
      "operations_count":   27,
      "data": {
        "symbol": [
          {
            "id":           928,
            "page_code":    "TAPIS9",
            "name":         "Test API Symbol",
            "blockchain":   1,
            "currency":     0,
            "test":         1,
          },
          {...}
        ]
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 26, data: {"symbols": [{"id":928,"page_code":"TAPIS9","name":"Test API Symbol","blockchain":1,"currency":0,"test":1}]}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Symbols

    List of symbol-pairs

    Request Data:

    {
      "hash": "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/trades/secondary_market/symbolpairs

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Response Data:

    {
      "message":            "Success.",
      "success":            true,
      "operations_count":   27,
      "data": {
        "symbolpairs": [
          {
            "symbol_id":     928,
            "currency_id":   806,
            "code":          "TAPIS9USD",
            "display":       "TAPIS9/USD"
          },
          {...}
        ]
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 27, data: {"symbolpairs": [{"symbol_id":928,"currency_id":806,"code":"TAPIS9USD","display":"TAPIS9/USD"}]}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Symbol Pairs

    Blockchain

    Default wallet

    Request Data:

    {
      "hash": "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/blockchain/wallet

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Response Data:

    {
      "message":            "Success.",
      "success":            true,
      "operations_count":   2,
      "data": {
        "default_wallet": [
          {
            "wallet_name":     "TestDBOT36 TestDBOT36 94",
            "wallet":   "0x1b648b4235c2bedd6fad4de5736de89d986729ac"
          }
        ]
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 27, data: {"default_wallet"=>[{"wallet_name"=>"TestDBOT36 TestDBOT36 94", "wallet"=>"0x1b648b4235c2bedd6fad4de5736de89d986729ac"}]}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array Default wallet

    Wallet list

    Request Data:

    {
      "hash": "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/blockchain/wallets

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Response Data:

    {
      "message":            "Success.",
      "success":            true,
      "operations_count":   2,
      "data": {
        "wallets": [
            {
                "wallet_name":  "TestDBOT36 TestDBOT36 2",
                "wallet":       "0xba2eea98a2a17df6573a6c1e19f88ebf1cabc275"
            },
            {
                "wallet_name":  "TestDBOT36 TestDBOT36 94",
                "wallet":       "0x1b648b4235c2bedd6fad4de5736de89d986729ac"
            }
        ]
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 27, data: {"wallets"=>[{"wallet_name"=>"TestDBOT36 TestDBOT36 2", "wallet"=>"0xba2eea98a2a17df6573a6c1e19f88ebf1cabc275"}, {"wallet_name"=>"TestDBOT36 TestDBOT36 94", "wallet"=>"0x1b648b4235c2bedd6fad4de5736de89d986729ac"}]}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    data Array Wallets list

    {"message"=>"Success.", "success"=>true, "data"=>{"wallets"=>[{"wallet_name"=>"TestDBOT36 TestDBOT36 2", "wallet"=>"0xba2eea98a2a17df6573a6c1e19f88ebf1cabc275"}, {"wallet_name"=>"TestDBOT36 TestDBOT36 94", "wallet"=>"0x1b648b4235c2bedd6fad4de5736de89d986729ac"}]}, "operations_count"=>2}

    Transactions list by wallet

    Request Data:

    {
      "hash": "eqav6crwfusl3g072otxhzmb9",
      "wallet": "0xba2eea98a2a17df6573a6c1e19f88ebf1cabc275",
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/blockchain/transactions

    Request Parameters

    Parameter Default Description
    hash String Hash-code
    wallet String wallet address

    Response Data:

    {
      "message":           "Success.",
      "success":           true,
      "operations_count":  29,
      "data": {
        "transactions": [
          {
            "operation_hash": "0x14acdadab367772d196bc747fbb89908670a62f9887d4aa287dc18ada6b4f4dd",
            "operations_data": [
              {
                "size":           0.04,
                "token_name":     "deUSD",
                "token_decimals": "4",
                "exchange_ref":   "",
                "operation_type": "Remove",
                "wallet":         "0xba2eea98a2a17df6573a6c1e19f88ebf1cabc275",
                "wallet_name":    "TestDBOT36 TestDBOT36 2",
                "fraction_base":  10000
              }
            ],
            "status":   "Confirmed",
            "datetime": "2018-06-27T17:55:12.000Z"
          },
          {...}
        ]
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 26, data: {"transactions": [...]}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array transactions list data

    Request Deposit

    Request Data:

    {
      "hash":       "eqav6crwfusl3g072otxhzmb9",
      "page_code":  "fdml",
      "wallet":     "0x9eefc28bc735c2ea5d53b8aa739aaab4b372d857",
      "amount":     10,
    }
    

    POST http://dbot-dev.fi-edition.com/api/v2/blockchain/request_deposit

    Request Parameters

    Parameter Default Description Possible Values
    hash String Hash-code
    page_code String Symbol code Symbol page_code from 'List of symbols'
    wallet String Wallet address Wallet from 'Wallets list'
    amount String Quantity Numerical digits

    Response(Errors) Data:

    {
      "message":            "Param 'page_code' can not be empty.",
      "operations_count":   27,
      "data":               {"request":{}},
      "success":            false
    }
    
    {
      "message":            "Param 'amount' can not be empty.",
      "operations_count":   28,
      "data":               {"request":{}},
      "success": false
    }
    
    {
      "message":            "Param 'wallet' can not be empty.",
      "operations_count":   29,
      "data":               {"request":{}},
      "success":            false
    }
    
    {
      "message":            "Wallet does not belong to user.",
      "operations_count":   30,
      "data":               {"request":{}},
      "success":            false
    }
    
    {
      "message":            "Symbol does not exist or not linked with blockchain.",
      "operations_count":   31,
      "data":               {"request":{}},
      "success":            false
    }
    
    {
      "message":            "Can not save request.",
      "operations_count":   32,
      "data":               {"request":{}},
      "success":            false
    }
    

    Response Error

    {message: "Param 'page_code' can not be empty.", "operations_count":27, "data":{request:{}}, success: false}

    {message: "Param 'amount' can not be empty.", "operations_count":28, "data":{request:{}}, success: false}

    {message: "Param 'wallet' can not be empty.", "operations_count":29, "data":{request:{}}, success: false}

    {message: "Wallet can not belong to user.", "operations_count":30, "data":{request:{}}, success: false}

    {message: "Symbol does not exist or not linked with blockchain.", "operations_count":31, "data":{request:{}}, success: false}

    {message: "Can not save request.", "operations_count":32, "data":{request:{}}, success: false}

    Response(Success) Data:

    {
      "message":            "Success.",
      "operations_count":   33,
      "data":               {
            "request":{
                "request_id":           4,
                "status":               "Pending",
                "blockchain_status":    "Pending",
                "blockchain_hash":      ""
            }
      },
      "success":            true
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 33, data: {"request":{"request_id"=>4, "status"=>"Pending", "blockchain_status"=>"Pending", "blockchain_hash"=>""}}}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array request data

    Request Status

    Request Data:

    {
      "hash": "eqav6crwfusl3g072otxhzmb9",
      "request_id": "4",
    }
    

    POST http://dbot-dev.fi-edition.com/api/v2/blockchain/request_status

    Request Parameters

    Parameter Default Description
    hash String Hash-code
    request_id String Request id identificator getting from 'Request Deposit'

    Response(Errors) Data:

    {
      "message":            "Param 'request_id' can not be empty.",
      "operations_count":   27,
      "data":               {"request":{}},
      "success":            false
    }
    
    {
      "message":            "Wrong request_id",
      "operations_count":   27,
      "data":               {"request":{}},
      "success":            false
    }
    

    Response Error

    {message: "Param 'request_id' can not be empty.", "operations_count":35, "data":{request:{}}, success: false}

    {message: "Wrong request_id", "operations_count":36, "data":{request:{}}, success: false}

    Response(Success) Data:

    {
      "message":            "Success.",
      "operations_count":   38,
      "data":               {
            "request":{
                "request_id":       4,
                "status":           "Pending",
                "blockchain_status":"Pending",
                "blockchain_hash":  ""
            }
      },
      "success":            true
    }
    
    {
      "message":            "Success.",
      "operations_count":   39,
      "data":               {
            "request":{
                "request_id":       4,
                "status":           "Declined",
                "blockchain_status":"Pending",
                "blockchain_hash":  ""
            }
      },
      "success":            true
    }
    
    {
      "message":            "Success.",
      "operations_count":   39,
      "data":               {
            "request":{
                "request_id":       4,
                "status":           "Approved",
                "blockchain_status":"Fixed",
                "blockchain_hash":  "0xa3ceaa5977ecdc99c3b6832bfb0900575a2434b056d6321e29108ba8473c4f2b"
            }
      },
      "success":            true
    }
    
    {
      "message":            "Success.",
      "operations_count":   40,
      "data":               {
            "request":{
                "request_id":       4,
                "status":           "Approved",
                "blockchain_status":"Reject",
                "blockchain_hash":  "0xa3ceaa5977ecdc99c3b6832bfb0900575a2434b056d6321e29108ba8473c4f2b"
            }
      },
      "success":            true
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 38, data: {"request":{"request_id"=>4, "status"=>"Pending", "blockchain_hash": "", "blockchain_status"=>"Pending"}}}

    {message: "Success.", success: true, operations_count: 38, data: {"request":{"request_id"=>4, "status"=>"Declined", "blockchain_hash": "", "blockchain_status"=>"Pending"}}}

    {message: "Success.", success: true, operations_count: 39, data: {"request":{"request_id"=>4, "status"=>"Approved", "blockchain_status"=>"Fixed", "blockchain_hash": "0xa3ceaa5977ecdc99c3b6832bfb0900575a2434b056d6321e29108ba8473c4f2b"}}}

    {message: "Success.", success: true, operations_count: 40, data: {"request":{"request_id"=>4, "status"=>"Approved", "blockchain_status"=>"Reject", "blockchain_hash": "0xa3ceaa5977ecdc99c3b6832bfb0900575a2434b056d6321e29108ba8473c4f2b"}}}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array request data

    Response "request" Parameters

    Parameter Default Description Possible Values
    request_id Integer Request id identificator
    status String Status. set by administrator Pending, Approved, Declined
    blockchain_status String Blockchain transaction status Pending, Fixed, Error, Reject
    blockchain_hash String Blockchain transaction hash

    Ethereum Entry Point

    Deposit

    Used for creating Ethereum Hot Wallet. Wallet used in ethereum global network

    Request Data:

    {
      "hash":   "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/blockchain/ethereum_deposit

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Base Response

    {message: "Success.", success: true, operations_count: 23, data: {"ethereum_deposit": ... }}

    Response Error "ethereum_deposit"

    Response Data:

    {
      "message":          "Success.",
      "success":          true,
      "operations_count": 23
      "data": {
        "ethereum_deposit": {
            "status_id": 8,
            "message":          "Can not create Ethereum Wallet",
            "success":          false,
            "ret": nil
        }
      }
    }
    
    

    {message: "Success.", success: true, operations_count: 23, data: {"ethereum_deposit": {"status_id": 8,"message":"Can not create Ethereum Wallet","success":false,"ret": nil}}}

    Response Data:

    {
      "message":          "Success.",
      "success":          true,
      "operations_count": 3,
      "data": {
        "ethereum_deposit": {
            "status_id":        0,
            "message":          "",
            "success":          true,
            "ret":              "0x09ddcfe3bf47643aa0c6f2f09379f5496719788c"
        }
      }
    }
    

    Response Success "ethereum_deposit"

    {message: "Success.", success: true, operations_count: 3, data: {"ethereum_deposit": {"status_id": 0,"message":"","success":true,"ret": "0x09ddcfe3bf47643aa0c6f2f09379f5496719788c"}}}

    Response Parameters "ethereum_deposit"

    Parameter Default Description
    status_id Integer Status ID for error responce
    message String Message from server for operation
    success Boolean Status of operation
    ret String Ethereum Hot Wallet Address

    Check

    Used for transfer funds from Ethereum Hot Wallet to Wallet in our Ethereum private network.

    Request Data:

    {
      "hash":   "eqav6crwfusl3g072otxhzmb9"
    }
    

    Request

    POST http://dbot-dev.fi-edition.com/api/v2/blockchain/ethereum_check

    Request Parameters

    Parameter Default Description
    hash String Hash-code

    Response Data:

    Response Parameters "ethereum_check"

    {
      "message":          "Success.",
      "success":          true,
      "operations_count": 23
      "data": {
        "ethereum_check": {
            "status_id": 11,
            "message": "No ETH available for Deposit in Ethereum Hot Wallet",
            "success": false
        }
      }
    }
    
    Parameter Default Description
    status_id Integer Status ID for error responce
    message String Message from server for operation
    success Boolean Status of operation

    Status Ids for Deposit and Check

    Statuses which can be returned in requests "Deposit" and "Check"

    Status ID Message Description
    1 Wallet "%wallet%" invalid
    2 Wallet "%wallet%" invalid
    3 "%token%" is not active or not linked to blockchain
    4 Hash "%hash%" invalid for resource transaction
    5 Hash "%hash%" - check successfully complite.
    6 Can not put transaction
    7 Can not find "%aggregate_symbol%" Symbol
    8 Can not create Ethereum Wallet
    9 All transactions are already processed
    10 There are %number% transactions processed
    11 No ETH available for Deposit in Ethereum Hot Wallet
    12 Request Error
    13 Transaction for %amount% ETH in progress to be Deposit
    14 %amount% ETH was minted to %wallet%
    15 Error while sending transaction
    16 Balance "%balance%" ETH will be insufficient
    17 Transaction is already in Pending state
    18 Please tranfer Deposit ETH to Ethereum Hot Wallet and click "Check button"
    19 Please click Deposit to get your Hot Wallet
    20 Transaction "%tx_hash%" was rejected. Please mail to administrator

    Common Responses

    Success

    Response Data:

    {
      "message":          "Success.",
      "success":          true,
      "operations_count": 3,
      "data": {
        ...
      }
    }
    

    Response Success

    {message: "Success.", success: true, operations_count: 3, data: {...}}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request
    operations_count Integer Account operations count for today
    data Array data

    Error. No hash

    Response Data:

    {
      "message": "Error! No hash.",
      "success": false
    }
    

    Response Error

    {message: "Error! No hash.", success: false}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request

    Error. No such hash

    Response Data:

    {
      "message": "Error! No such hash.",
      "success": false
    }
    

    Response Error

    {message: "Error! No such hash.", success: false}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request

    Error. Hash has been expired

    Response Data:

    {
      "message": "Error! Hash has been expired.",
      "success": false
    }
    

    Response Error

    {message: "Error! Hash has been expired.", success: false}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request

    Error. Api was disabled

    Response Data:

    {
      "message": "Error! Api was disabled.",
      "success": false
    }
    

    Response Error

    {message: "Error! Api was disabled.", success: false}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request

    Warning! Too much operations today

    You will receive this message if your operation quantity is larger than available quantity of operations.
    You may:
    1. Wait until tomorrow.
    2. Contact with Administrator.

    Response Data:

    {
      "message": "Warning! Too much operations today. Try again tomorrow.",
      "success": false
    }
    

    Response Error

    {message: "Warning! Too much operations today. Try again tomorrow.", success: false}

    Response Parameters

    Parameter Default Description
    message String Message from server for request
    success Boolean Status of request

    Operations Count

    Quantity of yours operations.
    Counts during the today day.

    Response Data:

    {
      "operations_count": 2
    }
    

    Response

    {operations_count: 2}

    Response Parameters

    Parameter Default Description
    operations_count Integer Account operations count for today

    FAQ

    Hash-code can be obtained from administrator

    Supporting value

    0 - DAY

    4 - IOC

    Other value will be wrong.

    type=1 — entry order

    type=0 — cancel order

    Supporting value

    "0" - Agency "1" - Principal "6" - ShortExemptL "12" - Riskless