openapi.json

{"openapi":"3.1.0","info":{"title":"GlobalTicketPay API","version":"1.2.0","description":"Search and monitor traffic citations across 309 automated court portals in Texas and Georgia. Access is invite-only. Georgia coverage is live and expanding (18 courts); the 291-court Texas footprint remains the deepest. All data endpoints require an API key sent as `Authorization: Bearer <key>`. The authoritative, live coverage list is `/jurisdictions`.","contact":{"name":"GlobalTicketPay","url":"https://www.globalticketpay.com/developers"}},"servers":[{"url":"https://www.globalticketpay.com/api/v1"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API key"}},"schemas":{"Ticket":{"type":"object","properties":{"citation_number":{"type":["string","null"]},"violation":{"type":["string","null"]},"fine_amount":{"type":["number","null"]},"currency":{"type":"string","example":"USD"},"due_date":{"type":["string","null"]},"status":{"type":["string","null"]},"defendant_name":{"type":["string","null"]},"court_name":{"type":["string","null"]},"source":{"type":["string","null"]}}},"Error":{"type":"object","properties":{"ok":{"type":"boolean","example":false},"request_id":{"type":"string"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object"}}}}}}},"paths":{"/":{"get":{"summary":"API discovery","security":[],"responses":{"200":{"description":"API metadata and endpoint index"}}}},"/status":{"get":{"summary":"API and engine health","security":[],"responses":{"200":{"description":"Operational status, including the live jurisdiction count across all supported states (currently TX + GA)."}}}},"/jurisdictions":{"get":{"summary":"List supported court portals","security":[],"parameters":[{"name":"region","in":"query","schema":{"type":"string"}},{"name":"state","in":"query","schema":{"type":"string","description":"Two-letter US state code, e.g. `TX` or `GA`."}},{"name":"search","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","default":100}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Paginated jurisdiction list across TX and GA"}}}},"/jurisdictions/{id}":{"get":{"summary":"Get one jurisdiction","security":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Jurisdiction detail"},"404":{"description":"Not found"}}}},"/lookup":{"post":{"summary":"Search citations across jurisdictions","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jurisdictions","driver_license","state"],"properties":{"jurisdictions":{"description":"Array of jurisdiction ids, or the string \"all\" (sweeps every supported court in TX and GA).","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":309},{"type":"string","enum":["all"]}]},"driver_license":{"type":"string","example":"12345678"},"state":{"type":"string","example":"TX","pattern":"^[A-Za-z]{2}$","description":"Two-letter US state code — currently `TX` (291 courts) or `GA` (18 courts live; expanding). Must match the state of every jurisdiction id supplied."},"first_name":{"type":"string"},"last_name":{"type":"string"},"date_of_birth":{"type":"string","format":"date","example":"1990-05-21"}}}}}},"responses":{"200":{"description":"Lookup results"},"401":{"description":"Unauthorized"},"422":{"description":"Validation error"},"429":{"description":"Rate limited / quota exceeded"}}}},"/warrant-check":{"post":{"summary":"Warrant-mode sweep across jurisdictions","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jurisdictions","driver_license","state"],"properties":{"jurisdictions":{"description":"Array of jurisdiction ids, or the string \"all\".","oneOf":[{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":309},{"type":"string","enum":["all"]}]},"driver_license":{"type":"string","example":"12345678"},"state":{"type":"string","example":"TX","pattern":"^[A-Za-z]{2}$","description":"Two-letter US state code — currently `TX` or `GA`. Must match the state of every jurisdiction id supplied."},"first_name":{"type":"string"},"last_name":{"type":"string"},"date_of_birth":{"type":"string","format":"date","example":"1990-05-21"}}}}}},"responses":{"200":{"description":"Warrant check results"},"401":{"description":"Unauthorized"},"429":{"description":"Rate limited / quota exceeded"}}}},"/usage":{"get":{"summary":"Caller's key usage and limits","responses":{"200":{"description":"Usage snapshot"},"401":{"description":"Unauthorized"}}}}}}