{"openapi":"3.1.0","info":{"title":"RegAlert for Agents — REST","version":"0.4.0","description":"The REST twins of the RegAlert MCP tools: the same inputs, the same defaults, JSON answers. Reference: https://mcp.regalert.today/llms.txt","contact":{"email":"ask@regalert.today"}},"servers":[{"url":"https://mcp.regalert.today"}],"security":[{"oauth":[]}],"paths":{"/v1/search":{"get":{"operationId":"searchDocuments","summary":"Full-text search over the documents","parameters":[{"name":"q","in":"query","required":true,"description":"Search words.","schema":{"type":"string"}},{"name":"regulator","in":"query","required":false,"description":"Regulator code, e.g. CBN. Some codes are used in several jurisdictions: give `jurisdiction` with them.","schema":{"type":"string"}},{"name":"jurisdiction","in":"query","required":false,"description":"Jurisdiction code: an ISO country code, e.g. NG; a US state is US-NY.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"One of: Africa, APAC, CentralAsia, EU, LATAM, MENAP, NA, SEA, SouthAsia, USA.","schema":{"type":"string"}},{"name":"topic","in":"query","required":false,"description":"One topic tag (GET /v1/topics).","schema":{"type":"string"}},{"name":"licence","in":"query","required":false,"description":"Licence slug, e.g. psp, emi, bank: documents that apply to it, plus documents for all regulated firms.","schema":{"type":"string"}},{"name":"in_force_only","in":"query","required":false,"description":"true = leave out documents marked superseded. Keeps documents with no known superseding document; that does not prove they are in force.","schema":{"type":"boolean","default":false}},{"name":"sort","in":"query","required":false,"description":"newest = the most recent of the 200 most relevant hits.","schema":{"type":"string","enum":["relevance","newest"],"default":"relevance"}},{"name":"limit","in":"query","required":false,"description":"Rows to return.","schema":{"type":"integer","minimum":1,"maximum":50,"default":10}},{"name":"fields","in":"query","required":false,"description":"Comma-separated columns. Default: uid,title,published,regulator,summary. All: uid,title,published,regulator,summary,summary_full,identifier,regulator_name,jurisdiction,jurisdiction_name,region,topics,url,in_force_status,applies_scope,applies_licences,effective_date.","schema":{"type":"string"}}],"responses":{"200":{"description":"`total` (exact) and `documents`.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"}}}},"/v1/recent":{"get":{"operationId":"recentDocuments","summary":"Documents newest first, with the exact total","parameters":[{"name":"regulator","in":"query","required":false,"description":"Regulator code, e.g. CBN. Some codes are used in several jurisdictions: give `jurisdiction` with them.","schema":{"type":"string"}},{"name":"jurisdiction","in":"query","required":false,"description":"Jurisdiction code: an ISO country code, e.g. NG; a US state is US-NY.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"One of: Africa, APAC, CentralAsia, EU, LATAM, MENAP, NA, SEA, SouthAsia, USA.","schema":{"type":"string"}},{"name":"topic","in":"query","required":false,"description":"One topic tag (GET /v1/topics).","schema":{"type":"string"}},{"name":"licence","in":"query","required":false,"description":"Licence slug, e.g. psp, emi, bank: documents that apply to it, plus documents for all regulated firms.","schema":{"type":"string"}},{"name":"in_force_only","in":"query","required":false,"description":"true = leave out documents marked superseded. Keeps documents with no known superseding document; that does not prove they are in force.","schema":{"type":"boolean","default":false}},{"name":"since","in":"query","required":false,"description":"First date, inclusive.","schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"description":"Last date, inclusive.","schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","required":false,"description":"Rows to return.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"offset","in":"query","required":false,"description":"Rows to skip.","schema":{"type":"integer","minimum":0,"default":0}},{"name":"fields","in":"query","required":false,"description":"Comma-separated columns. Default: uid,title,published,regulator,summary. All: uid,title,published,regulator,summary,summary_full,identifier,regulator_name,jurisdiction,jurisdiction_name,region,topics,url,in_force_status,applies_scope,applies_licences,effective_date,instrument_no,type,language,source,file_url,thumbnail_url,effective_kind,ended_on,ended_by,applies_activities.","schema":{"type":"string"}}],"responses":{"200":{"description":"`total`, `has_more` and `documents`.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"}}}},"/v1/documents/{uid}":{"get":{"operationId":"getDocument","summary":"One document: metadata, summary, lineage and text","parameters":[{"name":"uid","in":"path","required":true,"description":"Document uid.","schema":{"type":"string","format":"uuid"}},{"name":"query","in":"query","required":false,"description":"Words to look for: the answer is then the matching passages (`document.passages`), not a part of the text.","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"Start the text at this character.","schema":{"type":"integer","minimum":0,"default":0}},{"name":"max_chars","in":"query","required":false,"description":"Most characters to return. Default 40000; with `query`, 8000.","schema":{"type":"integer","minimum":1000,"maximum":400000}},{"name":"include_original","in":"query","required":false,"description":"true = also the original-language text.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"`document` with `text`, `text_next_offset`, `lineage`, and `enclosures` when the document holds annexes or forms.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"}}}},"/v1/documents/{uid}/lineage":{"get":{"operationId":"getLineage","summary":"A page of a document's confirmed citation links","parameters":[{"name":"uid","in":"path","required":true,"description":"Document uid.","schema":{"type":"string","format":"uuid"}},{"name":"direction","in":"query","required":false,"description":"outgoing = what this document cites; incoming = what cites it.","schema":{"type":"string","enum":["outgoing","incoming"],"default":"outgoing"}},{"name":"relation","in":"query","required":false,"description":"One relation; not given = all four.","schema":{"type":"string","enum":["amends","supersedes","issued_under","refers"]}},{"name":"limit","in":"query","required":false,"description":"Rows to return.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"offset","in":"query","required":false,"description":"Rows to skip.","schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"`edges`, `total`, `has_more`.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"}}}},"/v1/regulators":{"get":{"operationId":"listRegulators","summary":"The regulators and their codes","parameters":[{"name":"region","in":"query","required":false,"description":"One of: Africa, APAC, CentralAsia, EU, LATAM, MENAP, NA, SEA, SouthAsia, USA.","schema":{"type":"string"}},{"name":"jurisdiction","in":"query","required":false,"description":"Jurisdiction code, e.g. NG.","schema":{"type":"string"}},{"name":"query","in":"query","required":false,"description":"Part of a regulator's name, its code, or a country.","schema":{"type":"string"}},{"name":"all","in":"query","required":false,"description":"true = every regulator, with no filter.","schema":{"type":"boolean","default":false}},{"name":"fields","in":"query","required":false,"description":"Comma-separated columns. All: code,name,jurisdiction,jurisdiction_name,region,documents,website,status,last_checked_at,docs_30d,latest_published.","schema":{"type":"string"}}],"responses":{"200":{"description":"With no filter: totals by region (`view: regions`). Otherwise `regulators`.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"}}}},"/v1/topics":{"get":{"operationId":"listTopics","summary":"The topic tags, with document counts","responses":{"200":{"description":"`topics`.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"}}}},"/v1/account":{"get":{"operationId":"getAccount","summary":"This account's access","responses":{"200":{"description":"Access state.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"}}}}},"components":{"securitySchemes":{"oauth":{"type":"http","scheme":"bearer","description":"OAuth 2.1 access token from RegAlert sign-in. Discovery: https://mcp.regalert.today/.well-known/oauth-protected-resource"}},"responses":{"Problem":{"description":"What went wrong, and for a wrong code the values that were probably meant.","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"A stable code: unauthorized, unknown_regulator, ambiguous_regulator, not_found, fair_use, …"},"message":{"type":"string"},"suggestions":{"type":"array","items":{"type":"object"}},"hint":{"type":"string"}}}}}}}}}