# OpenSanctions System information API

**Canonical:** https://apis.io/apis/opensanctions/opensanctions-system-information-api/  
**Provider:** OpenSanctions — https://apis.io/providers/opensanctions/  
**Base URL:** https://api.opensanctions.org  
**Documentation:** https://www.opensanctions.org/docs/api/

OpenSanctions System information API is one of 4 APIs that [OpenSanctions](https://apis.io/providers/opensanctions/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include System Information. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Service metadata endpoints for health checking and getting the application metadata to be used in client applications.

## Operations (4)

| Method | Path | Summary |
|---|---|---|
| GET | `/healthz` | Health check |
| GET | `/readyz` | Search index readiness check |
| GET | `/algorithms` | Algorithms |
| POST | `/updatez` | Force an index update |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/opensanctions/refs/heads/main/openapi/opensanctions-system-information-api-openapi.yml
- **Documentation** — https://www.opensanctions.org/docs/api/
- **APIReference** — https://www.opensanctions.org/reference/
- **ToolCrosswalk** — https://raw.githubusercontent.com/api-evangelist/opensanctions/refs/heads/main/mcp/opensanctions-tool-crosswalk.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/opensanctions/refs/heads/main/data-model/opensanctions-data-model.yml

## Other OpenSanctions APIs (3)

- [OpenSanctions Data access API](https://apis.io/apis/opensanctions/opensanctions-data-access-api/)
- [OpenSanctions Matching API](https://apis.io/apis/opensanctions/opensanctions-matching-api/)
- [OpenSanctions Reconciliation API](https://apis.io/apis/opensanctions/opensanctions-reconciliation-api/)

## Tags

System Information

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/opensanctions/opensanctions-system-information-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/opensanctions/.