Referencia de la API
Documentación de la API
Una API JSON de solo lectura sobre los mismos datos de mercado que muestra este sitio. Las respuestas correctas usan el envoltorio { data, meta }; los fallos usan { error: { code, message } }.
- URL base
- http://localhost:3000
- Métodos
- Solo GET
- Formato
- JSON, UTF-8
- Límite de peticiones
- 60 peticiones cada 60 segundos, por dirección IP y endpoint
These are API examples. This site is served as static files.
MARKET_DATA_PROVIDER=fmp junto con FMP_API_KEY. El campo meta.provider de cada respuesta indica qué fuente ha respondido.Listar cotizaciones
/api/quotesDevuelve una página de instrumentos como un array plano, con total, page y pageSize en meta. Todos los filtros del cribador que aparecen abajo funcionan también aquí; los valores que no se pueden analizar se ignoran.
Parámetros
| Parámetro | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
| sector | query | string | Opcional | Nombre exacto del sector: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate. |
| sort | query | string | Opcional | Campo de ordenación: marketCap (por defecto), price, changePercent, volume o symbol. |
| order | query | string | Opcional | Orden de clasificación: desc (por defecto) o asc. |
| page | query | number | Opcional | Número de página, empezando por 1. |
| pageSize | query | number | Opcional | Filas por página: 20 por defecto, 100 como máximo. |
Petición
curl -s "http://localhost:3000/api/quotes?pageSize=3"Muestra de respuesta
200application/json
{
"data": [
{
"symbol": "NWRB",
"name": "Northwind Robotics",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Industrial Automation",
"price": 733.8,
"change": -16.52,
"changePercent": -2.2,
"previousClose": 750.32,
"open": 750.03,
"dayHigh": 751.29,
"dayLow": 731.5,
"volume": 3471317,
"avgVolume": 2962633,
"marketCap": 982258754565,
"peRatio": 60.35,
"eps": 12.16,
"dividendYield": null,
"week52High": 963.99,
"week52Low": 583.89,
"afterHoursPrice": 731,
"afterHoursChangePercent": -0.38,
"updatedAt": "2026-11-12T21:00:00.000Z"
}
],
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
"total": 20,
"page": 1,
"pageSize": 3
}
}La muestra se ha acortado a una fila.
Obtener una cotización
/api/quotes/{symbol}Devuelve la cotización completa de un instrumento o índice. Un símbolo desconocido devuelve 404 not_found.
Parámetros
| Parámetro | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
| symbol | path | string | Obligatorio | Símbolo de instrumento o índice, por ejemplo NWRB. La coincidencia ignora mayúsculas y minúsculas. |
Petición
curl -s "http://localhost:3000/api/quotes/NWRB"Muestra de respuesta
200application/json
{
"data": {
"symbol": "NWRB",
"name": "Northwind Robotics",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Industrial Automation",
"price": 733.8,
"change": -16.52,
"changePercent": -2.2,
"previousClose": 750.32,
"open": 750.03,
"dayHigh": 751.29,
"dayLow": 731.5,
"volume": 3471317,
"avgVolume": 2962633,
"marketCap": 982258754565,
"peRatio": 60.35,
"eps": 12.16,
"dividendYield": null,
"week52High": 963.99,
"week52Low": 583.89,
"afterHoursPrice": 731,
"afterHoursChangePercent": -0.38,
"updatedAt": "2026-11-12T21:00:00.000Z"
},
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice."
}
}Obtener velas
/api/candles/{symbol}Devuelve velas OHLCV, de la más antigua a la más reciente. El rango 1D usa intervalos de 30-minute; cualquier otro rango usa velas diarias. Un rango desconocido devuelve 400 bad_request.
Parámetros
| Parámetro | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
| symbol | path | string | Obligatorio | Símbolo de instrumento o índice, por ejemplo NWRB. La coincidencia ignora mayúsculas y minúsculas. |
| range | query | string | Opcional | Uno de 1D, 5D, 1M, 6M, 1Y, 5Y. Por defecto, 1M. |
Petición
curl -s "http://localhost:3000/api/candles/NWRB?range=1M"Muestra de respuesta
200application/json
{
"data": [
{
"time": "2026-11-11",
"open": 757.4,
"high": 761.18,
"low": 743.92,
"close": 750.32,
"volume": 3531710
},
{
"time": "2026-11-12",
"open": 750.03,
"high": 751.29,
"low": 731.5,
"close": 733.8,
"volume": 3471317
}
],
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
"symbol": "NWRB",
"range": "1M"
}
}La muestra se ha acortado a dos velas; 1M devuelve 22.
Cribar instrumentos
/api/screenerFiltra, ordena y pagina instrumentos con los mismos parámetros que la página del cribador. El resultado incluye rows junto con total, page y pageSize; los valores que no se pueden analizar se ignoran.
Parámetros
| Parámetro | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
| sector | query | string | Opcional | Nombre exacto del sector: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate. |
| minMarketCap, maxMarketCap | query | number | Opcional | Límites de capitalización de mercado en USD. |
| minPrice, maxPrice | query | number | Opcional | Límites de precio en USD. |
| minChangePercent, maxChangePercent | query | number | Opcional | Límites de variación diaria en puntos porcentuales: -3 significa -3%. |
| minVolume | query | number | Opcional | Volumen diario mínimo en acciones. |
| profitableOnly | query | string | Opcional | Se establece en 1 para conservar solo los instrumentos con EPS superior a 0. |
| sort | query | string | Opcional | Campo de ordenación: marketCap (por defecto), price, changePercent, volume o symbol. |
| order | query | string | Opcional | Orden de clasificación: desc (por defecto) o asc. |
| page | query | number | Opcional | Número de página, empezando por 1. |
| pageSize | query | number | Opcional | Filas por página: 20 por defecto, 100 como máximo. |
Petición
curl -s "http://localhost:3000/api/screener?profitableOnly=1&pageSize=5"Muestra de respuesta
200application/json
{
"data": {
"rows": [
{
"symbol": "NWRB",
"name": "Northwind Robotics",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Industrial Automation",
"price": 733.8,
"change": -16.52,
"changePercent": -2.2,
"previousClose": 750.32,
"open": 750.03,
"dayHigh": 751.29,
"dayLow": 731.5,
"volume": 3471317,
"avgVolume": 2962633,
"marketCap": 982258754565,
"peRatio": 60.35,
"eps": 12.16,
"dividendYield": null,
"week52High": 963.99,
"week52Low": 583.89,
"afterHoursPrice": 731,
"afterHoursChangePercent": -0.38,
"updatedAt": "2026-11-12T21:00:00.000Z"
}
],
"total": 17,
"page": 1,
"pageSize": 5
},
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
"total": 17,
"page": 1,
"pageSize": 5
}
}La muestra se ha acortado a una fila.
Autenticación
El modo de demostración no necesita clave. Cuando el servidor define la variable de entorno API_KEY, cada petición debe enviar el mismo valor en la cabecera X-API-Key; cualquier otro valor recibe 401 unauthorized.
curl -s "http://localhost:3000/api/quotes/NWRB" \
-H "X-API-Key: your-key-here"Códigos de error
Las peticiones fallidas devuelven un estado HTTP acorde y un único objeto de error. Bifurca por code; el message está escrito para personas y puede cambiar.
{
"error": {
"code": "not_found",
"message": "A human-readable explanation."
}
}| Estado HTTP | Código | Cuándo ocurre |
|---|---|---|
| 400 | bad_request | Un valor de parámetro no está permitido, por ejemplo un rango de velas desconocido. |
| 401 | unauthorized | API_KEY está configurada y la petición no tiene una cabecera X-API-Key coincidente. |
| 404 | not_found | El símbolo no existe en el conjunto de datos. |
| 405 | method_not_allowed | La API es de solo lectura: /api/quotes responde a POST con este código. |
| 429 | rate_limited | Más de 60 peticiones en 60 segundos desde una dirección IP a un endpoint. La respuesta incluye Retry-After en segundos. |
Consulta los mismos datos en el producto
El resumen de mercado, las páginas de cotización y el cribador leen el mismo proveedor que estos endpoints.