Get Indicative Stream Quotation

GET 
/v1/crossborder/stream-quotations

Returns a real-time indicative exchange rate for a given currency pair and side. This is not a firm quote (RFQ) and does not guarantee execution at the returned price.

Request

Query Parameters

base_currency_symbol stringrequired

Possible values: [USD]

Base currency symbol.

quote_currency_symbol stringrequired

Possible values: [BRL]

Quote currency symbol.

side stringrequired

Possible values: [BUY, SELL]

Side.

Header Parameters

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-product-uuid string

UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

x-product-target-user-uuid string

UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses

200

Stream quotation retrieved successfully.

application/json

Schema

Schema

id stringrequired

Stream Quotation ID.

base_currency_symbol stringrequired

Base currency symbol.

quote_currency_symbol stringrequired

Quote currency symbol.

price numberrequired

Rate price.

side stringrequired

Possible values: [BUY, SELL]

Side.

timestamp date-timerequired

Timestamp.

Example (from schema)

{
  "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "base_currency_symbol": "USD",
  "quote_currency_symbol": "BRL",
  "price": 5.1234,
  "side": "BUY",
  "timestamp": "2026-03-26T14:02:59.421Z"
}

401

User authentication failed.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 401,
  "error": "USER",
  "message": "Access is denied."
}

403

User access denied.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 403,
  "error": "USER",
  "message": "Access denied to requested resource. User may not have sufficient permission."
}

422

If any required params are missing or have invalid format or type.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 422,
  "error": "USER",
  "message": "The value BR is not accepted in param quote_currency_symbol. quote_currency_symbol must be one of the following values: BRL",
  "code": "VALIDATION"
}

Loading...