0Ingresar

CityFraction for Developers

Construye con los datos de activos reales

Una API REST sencilla para consultar los activos fraccionados de CityFraction —alojamientos y autos en renta—, sus precios, su avance de fraccionamiento y las tasas de cambio que usamos.

REST · JSONVersión v1CORS abiertoSin llave para datos públicos

$ curl https://cityfraction.com/api/v1/assets?status=open

{
  "data": [{
    "id": "CF-OAS9",
    "name": "Oasis Ciudad Amurallada",
    "type": "property",
    "city": "Cartagena",
    "status": "open",
    "fraction_price": { "usd": 50 },
    "fractions": { "available": 592 },
    "estimated_annual_yield_pct": 14.4
  }],
  "meta": { "api_version": "v1", "total": 5 }
}

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

  1. No necesitas registrarte para los datos públicos.
  2. Haz una solicitud GET al endpoint que necesites.
  3. Lee data y usa meta para paginar.
GET/api/v1/assets
curl -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

HTTPcodeSignificado
400invalid_parameterUn parámetro no tiene un valor permitido.
404not_foundEl activo no existe o no es público.
429rate_limitedSuperaste el límite de solicitudes.
500internal_errorError 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ámetroValores
typeproperty · vehicle
statusopen · funded
citytexto, p. ej. Miami
limit / offsetpaginación
GET/api/v1/assets
curl -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.

GET/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.

GET/api/v1/rates
curl -s "https://cityfraction.com/api/v1/rates" \
  -H "Accept: application/json"

El objeto Activo

CampoTipoDescripción
idstringCódigo público del activo, por ejemplo CF-OAS9.
slugstringIdentificador en la URL de la ficha.
namestringNombre comercial del activo.
typeenumproperty (alojamiento) o vehicle (auto en renta).
strategystringEstrategia de explotación, por ejemplo renta_corta o carros_turo.
citystringCiudad donde está el activo.
statusenumopen (fracciones disponibles) o funded (100 % fraccionado).
fraction_price.usdnumberPrecio de una fracción en el mercado primario (50 USD).
fraction_price.copnumberEquivalente en pesos colombianos a la tasa vigente.
fractions.total / sold / availableintegerFracciones totales, vendidas y disponibles.
fractions.sold_pctnumberPorcentaje fraccionado (0–100).
estimated_annual_yield_pctnumberRentabilidad anual estimada. No garantizada.
estimated_appreciation_pctnumberValorización anual estimada. No garantizada.
horizon_yearsintegerHorizonte de inversión en años.
imageurlFoto principal.
urlurlFicha 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.