v5

latestOpenAPI 3.1.0Proprietary2026-08-031,5423,1505.5 MB
Environment

Event statistics

Aggregated event statistics. Shows total counts, duration, and breakdowns by flag state and gear type for a given event type and date range.

get/api/v1/gfw/events/stats

Query parameters

typestring

Event type: fishing, encounter, loitering, port_visit.

Event type: fishing, encounter, loitering, port_visit.

start_datestring

Start date (YYYY-MM-DD). Default: 90 days ago.

Start date (YYYY-MM-DD). Default: 90 days ago.

end_datestring

End date (YYYY-MM-DD). Default: today.

End date (YYYY-MM-DD). Default: today.

Response

Aggregated event statistics broken down by flag state and gear type.

Example response

{
  "meta": {
    "endpoint": "/api/v1/fred/us/cpi",
    "data_time": "2026-04-16T14:30:00Z",
    "response_time": "2026-04-16T14:30:12Z",
    "provider": "Sugra API v1.0.1",
    "source": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ]
  }
}