Field Dictionary

GET /api/v1/certificates/fields

Return the field dictionary for a tax-certificate record: every field name, its type, a short description, and — for enumerated fields like status and vendor — the full set of allowed values. Use this to build dynamic filters, validate inputs client-side, or render column headers without hard-coding the schema.

Authentication

curl -H "X-API-Key: fltc_test_..." \
  "https://fltaxcerts.com/api/v1/certificates/fields"

Query Parameters

None.

Response (200)

Object envelope { data, meta }. data.fields is an array of field descriptors; enum fields carry a values array.

{
  "data": {
    "fields": [
      { "name": "id", "type": "string", "description": "Stable platform id for the certificate." },
      { "name": "certificate_number", "type": "string", "description": "County-assigned tax-certificate number." },
      { "name": "county_slug", "type": "string", "description": "County slug (see /counties)." },
      { "name": "parcel_id", "type": "string", "description": "County-assigned parcel id the lien attaches to." },
      { "name": "tax_year", "type": "integer", "description": "Tax year the certificate was issued for." },
      { "name": "status", "type": "enum", "values": ["available", "advertised", "sold", "redeemed", "lands_available", "tax_deed_applied", "cancelled"], "description": "Lifecycle state of the certificate." },
      { "name": "face_amount", "type": "number", "description": "Face value of the certificate at sale (delinquent tax plus fees and interest)." },
      { "name": "delinquent_amount", "type": "number", "description": "Underlying delinquent ad-valorem tax amount." },
      { "name": "interest_rate", "type": "number", "description": "Winning bid (interest) rate, percent. Bid down from 18%." },
      { "name": "sale_date", "type": "date", "description": "Date the certificate was sold at the county sale." },
      { "name": "holder_id", "type": "string", "description": "Id of the certificate holder / fund (see /holders)." },
      { "name": "holder_name", "type": "string", "description": "Name of the certificate holder / fund." },
      { "name": "vendor", "type": "enum", "values": ["lienhub", "realauction", "taxcertsale", "wfbs", "county-local"], "description": "Certificate-sale portal the record was sourced from." },
      { "name": "redeemed", "type": "boolean", "description": "Whether the certificate has been redeemed by the property owner." },
      { "name": "redeemed_date", "type": "date", "description": "Date of redemption, or null." },
      { "name": "redemption_amount", "type": "number", "description": "Amount paid to redeem, or null." },
      { "name": "tax_deed_application_date", "type": "date", "description": "Date the holder applied for a tax deed, or null." },
      { "name": "owner_name", "type": "string", "description": "Record owner of the parcel at time of sale." },
      { "name": "site_address_full", "type": "string", "description": "Situs address of the parcel." },
      { "name": "parcel_url", "type": "string", "description": "Cross-link to floridapropertyapi.com for parcel / owner / valuation detail." }
    ]
  },
  "meta": { "request_id": "req_1234567890abcdef12345", "dataset_status": "live" }
}

Error Responses

Status	Code	Cause
401	unauthorized	Missing or invalid API key.
429	rate_limited	Rate limit exceeded.
500	internal_error	Server error — retry with backoff.