{"swagger":"2.0","info":{"title":"flowerate","description":"Web api that provides hourly updated currency exchange rate and webhook for specified rate updates","contact":{"name":"Cheng"},"version":"0.0.1-dev"},"consumes":["application/json"],"produces":["application/json"],"paths":{},"definitions":{"FixerErrorDetail":{"type":"object","description":"fixer.io error detail inside a failure response","title":"FixerErrorDetail","required":["code","type"],"properties":{"code":{"description":"error code","type":"integer","format":"int64"},"type":{"description":"fixer.io error type","type":"string"}}},"FixerRatesFailureResponse":{"type":"object","description":"fixer.io failure response for exchange rate between two currencies","title":"FixerRatesFailureResponse","required":["success","error"],"properties":{"success":{"description":"response status, should be false in this case","type":"boolean"},"error":{"$ref":"#/definitions/FixerErrorDetail"}}},"FixerRatesSuccessResponse":{"type":"object","description":"fixer.io response for exchange rate between two currencies","title":"FixerRatesSuccessResponse","required":["success","base","rates","timestamp"],"properties":{"success":{"description":"response status, should be true in this case","type":"boolean"},"base":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWL"]},"rates":{"$ref":"#/definitions/map[double]"},"timestamp":{"description":"epoch timestamp of returned exchange rate","type":"integer","format":"int64"}}},"RateBetweenResponse":{"type":"object","description":"flowerate response for exchange rate between two currencies","title":"RateBetweenResponse","required":["base","target","rate","timestamp"],"properties":{"base":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWL"]},"target":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWL"]},"rate":{"description":"exchange rate, target currency to base currency","type":"number","format":"double"},"timestamp":{"description":"epoch timestamp of returned exchange rate","type":"integer","format":"int64"}}},"RateToAllResponse":{"type":"object","description":"flowerate response for exchange rate for base currency to all currencies","title":"RateToAllResponse","required":["base","rates","timestamp"],"properties":{"base":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWL"]},"rates":{"$ref":"#/definitions/map[double]"},"timestamp":{"description":"epoch timestamp of returned exchange rate","type":"integer","format":"int64"}}},"WebhookDetail":{"type":"object","description":"describe subscribed action and corresponding url of a webhook","title":"WebhookDetail","required":["currencyRateEvent","url"],"properties":{"currencyRateEvent":{"type":"string","enum":["CurrencyRateChange"]},"url":{"description":"where POST request to when subscribed event happens","type":"string"}}},"WebhookRegisterRequest":{"type":"object","description":"payload of POST request to register a webhook","title":"WebhookRegisterRequest","required":["clientId","webhooks"],"properties":{"clientId":{"description":"user id","type":"string"},"webhooks":{"type":"array","items":{"$ref":"#/definitions/WebhookDetail"}}}},"FixerRateResponse":{"type":"object","description":"Models rates response from fixer io","title":"FixerRateResponse","allOf":[{"$ref":"#/definitions/FixerRatesSuccessResponse"},{"$ref":"#/definitions/FixerRatesFailureResponse"}]}}}