flowerate 0.0.1-dev

Web api that provides hourly updated currency exchange rate and webhook for specified rate updates

  • Contact: Cheng
  • License: N/A

Resources

No resources

Headers

No headers

Imports

No imports

Enums

currency

Name Value Description
AED AED

AFN AFN

ALL ALL

AMD AMD

ANG ANG

AOA AOA

ARS ARS

AUD AUD

AWG AWG

AZN AZN

BAM BAM

BBD BBD

BDT BDT

BGN BGN

BHD BHD

BIF BIF

BMD BMD

BND BND

BOB BOB

BRL BRL

BSD BSD

BTC BTC

BTN BTN

BWP BWP

BYN BYN

BYR BYR

BZD BZD

CAD CAD

CDF CDF

CHF CHF

CLF CLF

CLP CLP

CNY CNY

COP COP

CRC CRC

CUC CUC

CUP CUP

CVE CVE

CZK CZK

DJF DJF

DKK DKK

DOP DOP

DZD DZD

EGP EGP

ERN ERN

ETB ETB

EUR EUR

FJD FJD

FKP FKP

GBP GBP

GEL GEL

GGP GGP

GHS GHS

GIP GIP

GMD GMD

GNF GNF

GTQ GTQ

GYD GYD

HKD HKD

HNL HNL

HRK HRK

HTG HTG

HUF HUF

IDR IDR

ILS ILS

IMP IMP

INR INR

IQD IQD

IRR IRR

ISK ISK

JEP JEP

JMD JMD

JOD JOD

JPY JPY

KES KES

KGS KGS

KHR KHR

KMF KMF

KPW KPW

KRW KRW

KWD KWD

KYD KYD

KZT KZT

LAK LAK

LBP LBP

LKR LKR

LRD LRD

LSL LSL

LTL LTL

LVL LVL

LYD LYD

MAD MAD

MDL MDL

MGA MGA

MKD MKD

MMK MMK

MNT MNT

MOP MOP

MRO MRO

MUR MUR

MVR MVR

MWK MWK

MXN MXN

MYR MYR

MZN MZN

NAD NAD

NGN NGN

NIO NIO

NOK NOK

NPR NPR

NZD NZD

OMR OMR

PAB PAB

PEN PEN

PGK PGK

PHP PHP

PKR PKR

PLN PLN

PYG PYG

QAR QAR

RON RON

RSD RSD

RUB RUB

RWF RWF

SAR SAR

SBD SBD

SCR SCR

SDG SDG

SEK SEK

SGD SGD

SHP SHP

SLL SLL

SOS SOS

SRD SRD

STD STD

SVC SVC

SYP SYP

SZL SZL

THB THB

TJS TJS

TMT TMT

TND TND

TOP TOP

TRY TRY

TTD TTD

TWD TWD

TZS TZS

UAH UAH

UGX UGX

USD USD

UYU UYU

UZS UZS

VEF VEF

VND VND

VUV VUV

WST WST

XAF XAF

XAG XAG

XAU XAU

XCD XCD

XDR XDR

XOF XOF

XPF XPF

YER YER

ZAR ZAR

ZMK ZMK

ZMW ZMW

ZWL ZWL

currencyRateEvent

Name Value Description
CurrencyRateChange CurrencyRateChange

Interfaces

No interfaces

Models

FixerErrorDetail

Example Json: Minimal | Full

Interfaces: None

fixer.io error detail inside a failure response

Field Type Required? Default Description
code long Yes -

error code

type string Yes -

fixer.io error type

FixerRatesFailureResponse

Example Json: Minimal | Full

Interfaces: None

fixer.io failure response for exchange rate between two currencies

Field Type Required? Default Description
success boolean Yes -

response status, should be false in this case

error FixerErrorDetail Yes -

error from fixer.io

FixerRatesSuccessResponse

Example Json: Minimal | Full

Interfaces: None

fixer.io response for exchange rate between two currencies

Field Type Required? Default Description
success boolean Yes -

response status, should be true in this case

base currency Yes -

base currency

rates map[double] Yes -

target currencies

timestamp long Yes -

epoch timestamp of returned exchange rate

RateBetweenResponse

Example Json: Minimal | Full

Interfaces: None

flowerate response for exchange rate between two currencies

Field Type Required? Default Description
base currency Yes -

base currency

target currency Yes -

targey currency

rate double Yes -

exchange rate, target currency to base currency

timestamp long Yes -

epoch timestamp of returned exchange rate

RateToAllResponse

Example Json: Minimal | Full

Interfaces: None

flowerate response for exchange rate for base currency to all currencies

Field Type Required? Default Description
base currency Yes -

base currency

rates map[double] Yes -

target currencies

timestamp long Yes -

epoch timestamp of returned exchange rate

WebhookDetail

Example Json: Minimal | Full

Interfaces: None

describe subscribed action and corresponding url of a webhook

Field Type Required? Default Description
currencyRateEvent currencyRateEvent Yes -

enum value, currency rate event that this webhook subscribe to

url string Yes -

where POST request to when subscribed event happens

WebhookRegisterRequest

Example Json: Minimal | Full

Interfaces: None

payload of POST request to register a webhook

Field Type Required? Default Description
clientId string Yes -

user id

webhooks [WebhookDetail] Yes -

a sequence of webhook details

Unions

FixerRateResponse

Interfaces: None

  • Type discriminator: N/A

Models rates response from fixer io

Type Discriminator Value Example Json Description
FixerRatesSuccessResponse FixerRatesSuccessResponse Minimal | Full

FixerRatesFailureResponse FixerRatesFailureResponse Minimal | Full

Annotations

No annotations