Developer API

SIDINGS exposes a public read-only machine API for listings discovery and ontology-aware interpretation. Contracts are versioned and served as live runtime OpenAPI artifacts.

Public Read APIContract: v1Auth: Anonymous

Quickstart

Base API URL

https://fast-track-api-gfhkaygncygbcpde.canadacentral-01.azurewebsites.net/api

  • Read-only endpoints for listings, facets, ontology, and changelog.
  • Responses include X-API-Version and X-Contract-Version.
  • Canonical values are emitted for ontology-backed fields.

Endpoint Catalog

Use CaseEndpoint
Build listings search pages or agent fetchersGET /api/public/listings
Fetch available machine filter vocabulary and policy classesGET /api/public/facets
Interpret canonical terms and aliases by listing familyGET /api/public/ontology
Track non-breaking vs breaking contract changesGET /api/public/changelog

Example Request

Query published transload listings in Texas:

curl -s "https://fast-track-api-gfhkaygncygbcpde.canadacentral-01.azurewebsites.net/api/public/listings?listingType=transload&state=TX&limit=20" \
  -H "Accept: application/json"

Example Response

Typical response envelope for /api/public/listings:

{
  "status": "success",
  "data": {
    "version": "2026-03-11.v1",
    "generatedAt": "2026-03-11T16:10:25.120Z",
    "data": [
      {
        "id": 123,
        "name": "Houston Transload Terminal",
        "listingType": "transload",
        "state": "TX"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalItems": 214,
      "totalPages": 11,
      "hasNextPage": true,
      "hasPrevPage": false
    },
    "nextPage": 2
  },
  "message": "Machine-readable public listings retrieved successfully",
  "timestamp": "2026-03-11T16:10:25.120Z"
}

Versioning Policy

  • Non-breaking additive changes are allowed.
  • Renames/removals require contract version bump and changelog entry.
  • Equivalent alias inputs are expected to resolve to stable canonical outputs.

For support and partnership questions, contact the SIDINGS team.