# Data Services API

The Data Services API enables developers to retrieve port and terminal datasets from the eModal lakehouse via REST—so you can power planning, visibility, and operational analytics in your own systems.
br
Access datasets such as available terminals, appointment availability, aggregated container dwell statistics, and appointment performance metrics—programmatically and consistently.

br
Use Data Services to enrich TMS/dispatch workflows, provide customer-facing visibility, and support reporting with trusted terminal metrics.

br
Download OpenAPI (swagger.json)
Generate SDKs, validate integrations, and version your API contracts using the OpenAPI description.

br
Download OpenAPI (swagger.yaml)
YAML format for tooling that prefers swagger.yaml.

## What is Data Services?

Data Services provides REST API access to operational datasets for ports and terminals sourced from the eModal lakehouse. It’s built for integrators who need reliable, structured terminal data for decisioning, dashboards, and workflow automation.

## Key Datasets Available

- **Terminals list**: Retrieve information about available terminals for a port.
- **Appointment availability**: Retrieve appointment availability in a specific terminal.
- **Container dwell statistics**: Retrieve aggregated container dwell statistics for a terminal.
- **Appointment performance**: Retrieve appointment performance metrics for a terminal.


## APIs Included

### TerminalMetrics

Use TerminalMetrics endpoints to query terminal datasets:

- `GET /terminalmetrics/v{version}/terminals`
List terminals available in the dataset.
- `GET /terminalmetrics/v{version}/terminals/{terminal_id}/apptavailability`
Get appointment availability for a terminal.
- `GET /terminalmetrics/v{version}/terminals/{terminal_id}/containerdwelltime`
Get aggregated container dwell statistics for a terminal.
- `GET /terminalmetrics/v{version}/terminals/{terminal_id}/apptperformance`
Get appointment performance metrics for a terminal.


## How Data Services Fits Into the CargoSprint Platform

Data Services complements other CargoSprint APIs by providing the terminal context behind workflows:

- [Pre-Gate](/pregate/overview) for upstream validation and exception avoidance.
- [SprintPass Pro](/sprintpasspro/overview) for appointment + payment orchestration and lifecycle tracing.
- [SprintPay](/sprintpay/overview) for cargo fee payments and confirmations.