Documentation

BlueHouse API

Compare rates

LiveImplemented and served directly by BlueHouse.

Returns the latest quote for every requested type plus percentage spreads against the oficial rate.

GET/api/v1/rates/compare

Parameters

FieldTypeDescription
typesHouseName CSVComma-separated houses to compare. Defaults to all houses.
field"buy" | "sell" | "mid"Quote side compared.

Response

FieldTypeDescription
dataobjectRates keyed by house plus the spread object.
ratesRecord<HouseName, number | null>Latest value of the selected field per requested house.
spreadRecord<string, number | null>Percentage difference against oficial, keyed as typeVsOficial.
queryTimenumberDatabase query duration in milliseconds.

Example

{
  "data": {
    "field": "sell",
    "rates": {
      "oficial": 1025,
      "blue": 1310,
      "tarjeta": 1378
    },
    "spread": {
      "blueVsOficial": 27.8049,
      "tarjetaVsOficial": 34.439
    }
  },
  "queryTime": 3
}