{"swaggerDoc":{"swagger":"2.0","info":{"title":"qiibee API","version":"1.0.0","description":"qiibee API specification","contact":{"name":"qiibee","url":"https://qiibee.com","email":"tech@qiibee.com"}},"basePath":"/","tags":[{"name":"Transactions"},{"name":"Tokens"},{"name":"Network"},{"name":"Prices"},{"name":"Addresses"}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/net":{"get":{"tags":["Network"],"description":"Gets network information","produces":["application/json"],"parameters":null,"responses":{"200":{"description":"Returns the network information"},"500":{"description":"Request failed, see error message"}}}},"/tokens/{contract}":{"get":{"tags":["Tokens"],"description":"Returns a specific Loyalty Token in the qiibee chain","produces":["application/json"],"parameters":[{"name":"contract","description":"Contract Address.","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Returns successfully a specific Loyalty Token on the qiibee chain"},"400":{"description":"Request failed due to wrong parameters, see error message"},"500":{"description":"Request failed, see error message"}}}},"/tokens":{"get":{"tags":["Tokens"],"description":"Returns a list of all Loyalty Tokens on the qiibee chain","produces":["application/json"],"parameters":[{"name":"from","description":"Users wallet address. If specified, the balance of each Loyalty Token for that address is returned.","in":"query","required":false,"type":"string"},{"name":"public","description":"If set to true, the balance balance of the QBX public token.","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"Returns successfully a List of all Loyalty Tokens on the qiibee chain"},"400":{"description":"Request failed due to wrong parameters, see error message"},"500":{"description":"Request failed, see error message"}}}},"/transactions/raw":{"get":{"tags":["Transactions"],"description":"Builds a raw transactions ready to be signed","produces":["application/json"],"parameters":[{"name":"from","description":"Address of the sender.","in":"query","required":true,"type":"string"},{"name":"to","description":"Beneficiary address of the loyalty tokens.","in":"query","required":true,"type":"string"},{"name":"contractAddress","description":"Loyalty Token contract address. Supply *either* the contract address *or* the token symbol.","in":"query","required":false,"type":"string"},{"name":"symbol","description":"Loyalty Token symbol. Supply *either* the contract address *or* the token symbol.","in":"query","required":false,"type":"string"},{"name":"transferAmount","description":"Amount of loyalty tokens being sent in wei.","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Returns loyalty transfer data ready to be signed and sent using the POST /transactions endpoint."},"400":{"description":"Request failed due to wrong parameters, see error message"},"404":{"description":"Request failed because the token is not found"},"500":{"description":"Request failed, see error message"}}}},"/transactions/{hash}":{"get":{"tags":["Transactions"],"description":"Returns the transaction {hash} information","produces":["application/json"],"parameters":[{"name":"hash","description":"Hash (identifier) of the transaction.","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Returns a JSON file containing the information relative to the transaction {hash}"},"400":{"description":"Request failed due to wrong parameters, see error message"},"500":{"description":"Request failed, see error message"}}}},"/transactions/":{"get":{"tags":["Transactions"],"description":"Returns the transaction {hash} information","produces":["application/json"],"parameters":[{"name":"symbol","description":"Token symbol to filter by.","in":"query","required":false,"type":"string"},{"name":"contractAddress","description":"Token contract address to filter by.","in":"query","required":false,"type":"string"},{"name":"limit","description":"Define what is the maximum number of transactions the response can contain (Default is 100, maximum is 100).","in":"query","required":false,"type":"integer"},{"name":"offset","description":"define the offset (how many transactions to be skipped) for the query.","in":"query","required":false,"type":"integer"},{"name":"wallet","description":"Wallet address to filter by (wallet == to || wallet == from)","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"Returns a JSON file containing the information relative to the transaction {hash}"},"400":{"description":"Request failed due to wrong parameters, see error message"},"500":{"description":"Request failed, see error message"}}}},"/transactions":{"post":{"tags":["Transactions"],"description":"Sends a signed transaction to the qiibee chain","produces":["application/json"],"parameters":[{"name":"data","description":"Signed transaction data in HEX format.","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"desc"},"400":{"description":"Request failed due to wrong parameters, see error message."},"409":{"description":"Request failed due to the nonce of the transaction being too low (already in use)."},"500":{"description":"Request failed, see error message"}}}},"/prices":{"get":{"tags":["Prices"],"description":"Returns the FIAT price of one unit of a given Loyalty Token. This endpoint uses a third-party provider to get the ETH echange rate. The QBX/ETH Exchange rate is fetched from the Coinsuper exchange.","produces":["application/json"],"parameters":[{"name":"from","description":"Loyalty Token contract address.","in":"query","required":true,"type":"string"},{"name":"to","description":"Comma separated currency symbols list to convert into. E.g USD,EUR,CHF. Default value is USD.","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"Returns a list of all Loyalty Tokens in the qiibee chain"},"400":{"description":"Request failed due to wrong parameters, see error message"},"500":{"description":"Request failed, see error message"}}}},"/prices/history":{"get":{"tags":["Prices"],"description":"Returns the historical FIAT price values of one unit of a given Loyalty Token for a desired currency. This endpoint uses a third-party provider to get the ETH exchange rate. The QBX/ETH Exchange rate is fetched from the Coinsuper exchange.","produces":["application/json"],"parameters":[{"name":"from","description":"Loyalty Token contract address.","in":"query","required":true,"type":"string"},{"name":"to","description":"Comma separated currency symbols list to convert into. E.g USD,EUR,CHF","in":"query","required":true,"type":"string"},{"name":"frequency","description":"Get values by day from the historical data. Default value is day, currently only day frequency supported.","in":"query","required":false,"type":"string"},{"name":"limit","description":"The number of data points to return. Default is 30.","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"Returns a list of all the FIAT values for the given Loyalty Tokens."},"400":{"description":"Request failed due to wrong parameters, see error message"},"500":{"description":"Request failed, see error message"}}}},"/addresses/{address}":{"get":{"tags":["Addresses"],"description":"Returns address information along with balances for each Loyalty Token.","produces":["application/json"],"parameters":[{"name":"address","description":"Users wallet address.","in":"path","required":true,"type":"string"},{"name":"public","description":"Include balance of QBX and ETH on public chain","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"Returns successfully the details of that address (token balances and transaction count)."},"400":{"description":"Request failed due to wrong parameters, see error message"},"500":{"description":"Request failed, see error message"}}}}},"definitions":{},"responses":{},"parameters":{},"securityDefinitions":{}},"customOptions":{}}