Coverage

Catalog coverage

GET/coverage

Published record counts by resource, manufacturer, release year and field presence, limited to the club resources the key can access. Requires any club resource entitlement. Query parameters return 400. Returns 503 when no build is published. Supports ETag revalidation.

Parameters2

Headers

  • Golfapi-Versionstring (date)

    API version. 2026-10-02 is the only version served, and the default when the header is omitted. Any other date is 400, including the retired versions GET / lists under version.retired. A malformed date is 400.

    2026-10-02Default 2026-10-02
  • If-None-Matchstring

    ETag retained for this exact representation URL and version. A 304 is not charged against the rate limit, and its RateLimit-Remaining names the budget after that refund.

Responses9

  • 200

    Published catalog counts.

  • 304

    Unchanged representation, no response body. Quota refunded after response.

  • 400

    Invalid recognized input or projected field.

  • 401

    Missing, malformed, unknown, or revoked key.

  • 403

    Resource/capability not granted.

  • 405

    A routed path reached by a method other than GET or OPTIONS.

  • 429

    Rate limit reached. 60 requests per 60-second wall-clock window by default; RateLimit-Limit carries this key’s actual cap. Honor Retry-After, which equals RateLimit-Reset.

  • 500

    Server fault.

  • 503

    Required representation or schema unavailable; honor Retry-After.

Response schema5 fields

  • buildstringRequired
  • published_atstring (date-time)Required
  • catalog_completebooleanRequired

    Whether the catalog covers its launch scope. False. Every count in this response describes published records, so a search miss, an empty page and a 404 are statements about this build and not about what exists.

  • notestring

    Plain-language restatement of what the counts do and do not establish.

  • resourcesResourceCoverage[]Required

    Only club types accessible to this key.

This page as Markdown