Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/PDNMX/s1_backend/llms.txt

Use this file to discover all available pages before exploring further.

The /v1/providers endpoint returns the full list of data suppliers (providers) that the gateway has been configured to query. Each provider entry is loaded from the internal endpoints.json configuration file, but only safe metadata fields are exposed — sensitive connection details such as credentials, token URLs, and upstream endpoint URLs are never included in the response. The supplier_id values returned here are the identifiers you pass to /v1/search and /v1/summary to target a specific provider.

Endpoint

GET /v1/providers

Request

No authentication, query parameters, or request body are required.
curl http://localhost:3101/v1/providers

Response

Returns HTTP 200 OK with a JSON array. Each element represents one configured data provider.
Example Response
[
  {
    "supplier_id": "EDOMEX",
    "supplier_name": "Secretaría Ejecutiva del Sistema Estatal Anticorrupción del Estado México",
    "levels": ["estatal"],
    "status": null
  }
]
supplier_id
string
Unique identifier for the data provider. Use this value as the supplier_id field in /v1/search requests and as the institucion.supplier_id field in /v1/summary requests.
supplier_name
string
Full human-readable name of the institution or anti-corruption system entity that operates this data provider.
levels
array of strings
Government levels this provider belongs to. Possible values are "federal", "estatal", and "municipal". Used by /v1/summary to filter providers by the nivel_gobierno field.
status
string | null
Optional operational status of the provider. May be null if no status has been configured.
Sensitive connection details present in the internal configuration — including username, password, client_id, client_secret, token_url, and url — are never included in the response. Only the four metadata fields listed above are returned.

Build docs developers (and LLMs) love