Developer

API Documentation

A REST API for real-time ocean freight. Query rates, automate bookings, and build logistics tools directly on top of carrier data — no scrapers, no middlemen.

Overview

The EncoreLinx API gives you direct access to live carrier data — rates, schedules, and availability — without dealing with individual carrier portals or unstable scrapers. Build once, get data from all integrated carriers in a single normalized response.

Base URL

https://api.encorelinx.com/v1

Current version

All endpoints are prefixed with /v1. Breaking changes will be introduced under a new version path. The current stable version is v1.

Response format

All responses are returned as JSON. Successful responses use HTTP 200. Errors return the appropriate 4xx or 5xx status with a structured error body.

API types

Type	Key prefix	Access	Description
Public	`pk_`	Read-only	Rate queries, carrier schedules, route availability
Private	`sk_`	Full access	Bookings, account data, shipment tracking

Rate limits

Plan	Requests / min	Requests / day
Starter	60	5,000
Growth	300	50,000
Enterprise	Unlimited	Unlimited

Quick Start

Get your first rate query running in under five minutes.

Create your account

Get your API key

Public keys (pk_live_…) are safe for server-side rate queries. Keep secret keys (sk_live_…) out of client-side code and version control.

Make your first request

Query rates from Santos, Brazil (BRSAO) to Shanghai, China (CNSHA) for a 20ft dry container.

curl "https://api.encorelinx.com/v1/rates?origin=BRSAO&destination=CNSHA&container=20DC" \
  -H "Authorization: Bearer pk_live_xxxxxxxxxxxxxxxx"

Handle the response

The data array contains one entry per carrier with live rates. total includes the base rate plus all surcharges in USD.

Authentication

The EncoreLinx API uses API keys for authentication. All requests must include your key in the Authorization header using the Bearer scheme.

Authorization header

Authorization: Bearer YOUR_API_KEY

Public vs. private keys

Your dashboard issues two key types — choose the right one for each use case.

pk_

Public key

Read-only access to rates, schedules, and carrier data. Safe for server-to-server calls but never expose in browser code or mobile apps.

sk_

Secret key

Full access to bookings, account data, and private endpoints. Treat it like a password — never commit to version control or share publicly.

Authenticated request example

curl "https://api.encorelinx.com/v1/bookings" \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"rate_id": "rate_abc123", "contact_email": "ops@company.com"}'

Error codes

Status	Code	Meaning
401	`unauthorized`	Missing or invalid API key
403	`forbidden`	Key does not have permission for this endpoint
429	`rate_limited`	Too many requests — check your plan limits

Key rotation

You can rotate API keys at any time from the dashboard without downtime. Create a new key, update your integration, then revoke the old one.