Introducción
La API de CityFraction expone, en formato JSON, la información pública de los activos que se pueden fraccionar en la plataforma. Es ideal para comparadores, medios, integraciones de socios y tableros de seguimiento.
URL base
https://cityfraction.com/api/v1
Formato
JSON (UTF-8)
Versión
v1 · estable
Todas las respuestas tienen la forma { data, meta }; los errores, { error: { code, message } }.
Inicio rápido
- No necesitas registrarte para los datos públicos.
- Haz una solicitud GET al endpoint que necesites.
- Lee
datay usametapara paginar.
/api/v1/assetscurl -s "https://cityfraction.com/api/v1/assets" \
-H "Accept: application/json"Autenticación
Los endpoints de la versión v1 son públicos y de solo lectura: no requieren llave. La API para socios (datos de cuentas, órdenes y webhooks, con llaves privadas por aplicación y OAuth) está en desarrollo; puedes pedir acceso anticipado escribiendo a [email protected].
# Próximamente (API de socios)
curl https://cityfraction.com/api/v1/... \
-H "Authorization: Bearer cf_live_••••••••"Límites de uso
Cada dirección IP puede hacer hasta 120 solicitudes por minuto. Si superas el límite recibirás un 429 rate_limited. Las respuestas se cachean hasta 60 segundos: no necesitas consultar más seguido.
Errores
| HTTP | code | Significado |
|---|---|---|
| 400 | invalid_parameter | Un parámetro no tiene un valor permitido. |
| 404 | not_found | El activo no existe o no es público. |
| 429 | rate_limited | Superaste el límite de solicitudes. |
| 500 | internal_error | Error inesperado; reintenta con espera exponencial. |
{
"error": { "code": "not_found", "message": "No existe un activo público con id CF-XXXX." }
}Paginación
Los listados aceptan limit (1–100, por defecto 50) y offset. En meta.total recibes el total de resultados.
Listar activos
Devuelve los activos públicos (alojamientos y autos). Los inmuebles del club privado de remates no se exponen.
| Parámetro | Valores |
|---|---|
| type | property · vehicle |
| status | open · funded |
| city | texto, p. ej. Miami |
| limit / offset | paginación |
/api/v1/assetscurl -s "https://cityfraction.com/api/v1/assets" \
-H "Accept: application/json"Detalle de un activo
Usa el código (CF-OAS9) o el slug. Incluye descripción, galería, ubicación, valor total y, en autos, la ficha del vehículo.
/api/v1/assets/{id}curl -s "https://cityfraction.com/api/v1/assets/{id}" \
-H "Accept: application/json"Tasas de cambio
Las tasas de referencia con las que CityFraction convierte montos (pesos colombianos por unidad) y el precio primario de la fracción.
/api/v1/ratescurl -s "https://cityfraction.com/api/v1/rates" \
-H "Accept: application/json"El objeto Activo
| Campo | Tipo | Descripción |
|---|---|---|
| id | string | Código público del activo, por ejemplo CF-OAS9. |
| slug | string | Identificador en la URL de la ficha. |
| name | string | Nombre comercial del activo. |
| type | enum | property (alojamiento) o vehicle (auto en renta). |
| strategy | string | Estrategia de explotación, por ejemplo renta_corta o carros_turo. |
| city | string | Ciudad donde está el activo. |
| status | enum | open (fracciones disponibles) o funded (100 % fraccionado). |
| fraction_price.usd | number | Precio de una fracción en el mercado primario (50 USD). |
| fraction_price.cop | number | Equivalente en pesos colombianos a la tasa vigente. |
| fractions.total / sold / available | integer | Fracciones totales, vendidas y disponibles. |
| fractions.sold_pct | number | Porcentaje fraccionado (0–100). |
| estimated_annual_yield_pct | number | Rentabilidad anual estimada. No garantizada. |
| estimated_appreciation_pct | number | Valorización anual estimada. No garantizada. |
| horizon_years | integer | Horizonte de inversión en años. |
| image | url | Foto principal. |
| url | url | Ficha pública del activo en cityfraction.com. |
| description, images, location, total_value, vehicle, updated_at | — | Solo en el detalle (GET /assets/{id}). |
Webhooks
En desarrollo
Los webhooks para socios (por ejemplo, cuando un activo queda 100 % fraccionado o cambia su precio) llegarán con la API de socios. Escríbenos si tu integración los necesita.
Buenas prácticas
- Guarda en caché las respuestas al menos 60 segundos.
- Ante errores 429 o 5xx, reintenta con espera exponencial.
- Las rentabilidades son estimaciones: muéstralas siempre como tales y enlaza la ficha del activo.
- Cita a CityFraction como fuente y no sugieras que los datos constituyen una oferta de inversión.
Al usar la API aceptas los términos de CityFraction.
Historial de cambios
6 de octubre de 2026 · v1
Lanzamiento de la API pública
Endpoints de activos, detalle de activo y tasas de cambio.
Soporte
¿Dudas o una integración especial? Escríbenos a [email protected] o por WhatsApp al +1 786-827-0990. Consulta el estado del servicio en /estado.