Referencia de la API de precios

Referencia completa de los endpoints de la API de precios. Obtén precios de tokens, monedas, tipos de cambio entre monedas y cotizaciones fiat.

URL base

https://api.orcarail.com/api/v1

Precio de un token

Obtener el precio de un token

Obtén el último precio en USD de un token a partir de su ID.

GET /price/token/:tokenId

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción
tokenId	string	Sí	ID del token (UUID)

Respuesta

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tokenId": "550e8400-e29b-41d4-a716-446655440001",
  "priceUsd": "2500.00",
  "source": "coingecko",
  "createdAt": "2024-01-01T00:00:00.000Z"
}

Devuelve null si no hay precio disponible para el token.

Campos de la respuesta

Campo	Tipo	Descripción
id	string	ID del registro de precio (UUID)
tokenId	string	ID del token (UUID)
priceUsd	string	Precio en USD
source	string	Fuente del precio (por ejemplo coingecko, manual)
createdAt	string	Marca de tiempo ISO 8601

Monedas

Listar monedas

Lista las monedas fiat/de visualización compatibles.

GET /price/currencies

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
active	string	No	Ponlo a true para devolver solo las monedas activas

Respuesta

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "code": "USD",
    "name": "US Dollar",
    "symbol": "$",
    "decimals": 2,
    "isActive": true,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
]

Tipo de cambio

Obtener un tipo de cambio

Obtén el último tipo de cambio entre dos monedas (base y cotizada).

GET /price/currency-rate/:baseId/:quoteId

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción
baseId	string	Sí	ID de la moneda base (UUID)
quoteId	string	Sí	ID de la moneda cotizada (UUID)

Respuesta

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "baseCurrencyId": "550e8400-e29b-41d4-a716-446655440001",
  "quoteCurrencyId": "550e8400-e29b-41d4-a716-446655440002",
  "rate": "590000.00",
  "source": "manual",
  "createdAt": "2024-01-01T00:00:00.000Z"
}

Devuelve null si no hay tipo de cambio disponible para el par.

Campos de la respuesta

Campo	Tipo	Descripción
id	string	ID del registro del tipo de cambio (UUID)
baseCurrencyId	string	ID de la moneda base (UUID)
quoteCurrencyId	string	ID de la moneda cotizada (UUID)
rate	string	Tipo de cambio (1 base = rate cotizada)
source	string	Fuente del tipo de cambio (por ejemplo manual)
createdAt	string	Marca de tiempo ISO 8601

Cotización fiat

Obtener una cotización fiat

Obtén una cotización de fiat a USD/USDC. Opcionalmente, obtén el importe equivalente en un token concreto.

GET /price/fiat-quote

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
amount	string	Sí	Importe en la moneda de origen (por ejemplo 100000)
currency	string	Sí	Código de la moneda de origen (por ejemplo irr, usd)
tokenId	string	No	ID del token (UUID) para obtener el importe en ese token

Respuesta

{
  "amountUsd": "2.38",
  "amountUsdc": "2.38",
  "sourceAmount": "100000",
  "sourceCurrency": "irr",
  "currencyRateId": "550e8400-e29b-41d4-a716-446655440000",
  "tokenAmount": "0.00052",
  "tokenSymbol": "ETH"
}

Si no se indica tokenId, se omiten tokenAmount y tokenSymbol. Si la moneda de origen es USD, currencyRateId puede ser null.

Campos de la respuesta

Campo	Tipo	Descripción
amountUsd	string	Importe en USD
amountUsdc	string	Importe en USDC (igual que en USD para la stablecoin)
sourceAmount	string	Importe original en la moneda de origen
sourceCurrency	string	Código de la moneda de origen
currencyRateId	string | null	ID del tipo de cambio usado en la conversión (null si es USD)
tokenAmount	string	Opcional. Importe en el token elegido (si se indica tokenId)
tokenSymbol	string	Opcional. Símbolo del token elegido (si se indica tokenId)

Códigos de estado

Código de estado	Descripción
200	Correcto
404	No encontrado (por ejemplo, no hay precio ni tipo de cambio para esos ID)
500	Error interno del servidor

Consulta también

• Pagos: redes y tokens (para los ID de token)
• Panel: saldos y volúmenes
• Referencia de la API del SDK de Node: orcarail.rates.getFiatQuote y getCurrencies
• Demo: uso del selector de moneda y de la cotización fiat