map

Turn the Map API on (charges the monthly minimum)

Any paying business account can turn the Map API on, with a secret API key or an admin session. A map browser key is not accepted here.

  1. acceptMinimum must be true.

  2. The account needs a payment method on file. A free-trial account is refused.

  3. The monthly minimum ($300) is charged to the card at that moment. It covers the current calendar month. If the charge fails, nothing is turned on.

  4. The plan is active at once on the same key. A confirmation email is sent.

Later months are settled on the month-end invoice: usage, or the minimum if usage is lower. The minimum is applied toward everything the account uses that month, search included. The month of turn-on is invoiced at month end as max(total usage, 300) − 300 already paid.

Calling this on an account that is already on changes nothing and charges nothing. Turning it on again in a month it was already paid for charges nothing more.

post/v1/map/enable

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/map/enable
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

acceptMinimumboolean required

Must be true: you agree to the monthly minimum, which is charged now.

Response

The plan after the call, with what was charged.

enabledboolean

The Map API is on.

pausedboolean
sandboxboolean

The plan answers in test mode.

everEnabledboolean
enabledAtstring date-time nullable
disabledAtstring date-time nullable
pinMinZoominteger

Pins start at this zoom.

nameMinZoominteger

Names start at this zoom.

maxMarkersinteger

Most pins in one response.

maxTilesPerRequestinteger

Most tiles one view may cover at its zoom.

markerIdTtlSecondsinteger

How long marker and group ids work.

markerFields'basic' | 'named'

basic labels read J. Smith; named labels read John Smith.

minimumUsdnumber

The monthly minimum, in dollars.

minimumWaivedUntilstring date nullable
minimumAppliesThisMonthboolean
minimumPaidThisMonthUsdnumber

What was charged toward this month's minimum when the Map API was turned on.

termsstring[]

The rates and the minimum, in sentences.

changedboolean

false when the Map API was already on; nothing was charged.

Example response

{
  "pinMinZoom": 13,
  "nameMinZoom": 15,
  "maxMarkers": 300,
  "maxTilesPerRequest": 64,
  "markerIdTtlSeconds": 86400,
  "rates": {
    "requestUsdPer1k": 2,
    "recordOpenUsd": 0.015
  },
  "minimumUsd": 300,
  "sweep": {
    "tilesPerDay": 20000,
    "endUserTilesPerDay": 2000
  },
  "charged": {
    "usd": 300,
    "covers": "October 2026"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.