OpenSanctions

OpenSanctions System information API

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

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /healthz Check that the service is responsive · Health check #
Ask an LLM
“Is the screening service up and responding to requests?”
“What liveness endpoint can Kubernetes probe for this service?”
Tell an agent
Run the basic health check on the service.
Ping the liveness probe to confirm the API is responsive.
GET /readyz Check whether the search index is built · Search index readiness check #
Ask an LLM
“Has the search index finished building so queries will return results?”
“Can I tell if the service is ready to serve searches after a restart?”
Tell an agent
Check the readiness probe to see if index building is complete.
Confirm the search index is ready before I start screening.
GET /algorithms List the supported matching algorithms · Algorithms #
Ask an LLM
“Which scoring algorithms can the matcher use?”
“What algorithm names are valid when I tune entity matching?”
Tell an agent
List the available matching and scoring algorithms.
Show me every algorithm the match endpoint supports.
POST /updatez Force the search index to rebuild · Force an index update #
Ask an LLM
“How do I trigger a rebuild of the index on my self-hosted instance?”
“Does forcing an index regeneration need the update token configured in the container environment?”
Tell an agent
Force an index update using update token {token}.
Regenerate the index with token {token} and sync set to {sync}.

Documentation

📖
Documentation
https://www.opensanctions.org/docs/api/
📖
APIReference
https://www.opensanctions.org/reference/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/opensanctions/refs/heads/main/openapi/opensanctions-system-information-api-openapi.yml

Other Resources

🔗
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/opensanctions:opensanctions-system-information-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

opensanctions-system-information-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenSanctions System information API
  description: '## Introduction


    The OpenSanctions API allows users to search and query

    the OpenSanctions entity graph.'
  termsOfService: https://www.opensanctions.org/docs/terms
  contact:
    name: OpenSanctions
    url: https://www.opensanctions.org/
    email: info@opensanctions.org
  version: yente 5.5.0
  x-logo:
    url: https://assets.opensanctions.org/images/ura/logo_text_spaced.svg
  externalDocs:
    description: Home page
    url: https://www.opensanctions.org
tags:
- name: System Information
  description: Service metadata endpoints for health checking and getting the application metadata to be used in client applications.
paths:
  /healthz:
    get:
      tags:
      - System Information
      summary: Health check
      description: 'No-op basic health check. This is used by cluster management systems like

        Kubernetes to verify the service is responsive.'
      operationId: healthz_healthz_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '500':
          description: Service is not ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /readyz:
    get:
      tags:
      - System Information
      summary: Search index readiness check
      description: 'Search index health check. This is used to know if the service has completed

        its index building.'
      operationId: readyz_readyz_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '503':
          description: Index is not ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /algorithms:
    get:
      tags:
      - System Information
      summary: Algorithms
      description: 'Return a list of the supported matching/scoring algorithms used by the matching

        endpoint.


        See also the scoring documentation.'
      operationId: algorithms_algorithms_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlgorithmResponse'
  /updatez:
    post:
      tags:
      - System Information
      summary: Force an index update
      description: 'Force the index to be re-generated. Works only if the update token is provided

        (serves as an API key, and can be set in the container environment).'
      operationId: force_update_updatez_post
      parameters:
      - name: token
        in: query
        required: false
        schema:
          type: string
          title: Update token for authentication
          default: ''
      - name: sync
        in: query
        required: false
        schema:
          type: boolean
          title: Wait until indexing is complete
          default: false
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '403':
          description: Authorization error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ConfigVarType:
      type: string
      enum:
      - string
      - integer
      - float
      - boolean
      title: ConfigVarType
      description: The type of a configuration variable.
    StatusResponse:
      properties:
        status:
          type: string
          title: Status
          default: ok
      type: object
      title: StatusResponse
    ConfigVar:
      properties:
        type:
          $ref: '#/components/schemas/ConfigVarType'
          default: float
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        default:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
          - type: 'null'
          title: Default
          default: 0
      type: object
      title: ConfigVar
      description: A configuration variable for a scoring algorithm.
    AlgorithmResponse:
      properties:
        algorithms:
          items:
            $ref: '#/components/schemas/Algorithm'
          type: array
          title: Algorithms
        default:
          type: string
          title: Default
        best:
          type: string
          title: Best
      type: object
      required:
      - algorithms
      - default
      - best
      title: AlgorithmResponse
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          examples:
          - Detailed error message
      type: object
      required:
      - detail
      title: ErrorResponse
    AlgorithmDocs:
      properties:
        name:
          type: string
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        config:
          additionalProperties:
            $ref: '#/components/schemas/ConfigVar'
          type: object
          title: Config
        features:
          additionalProperties:
            $ref: '#/components/schemas/FeatureDoc'
          type: object
          title: Features
      type: object
      required:
      - name
      - config
      - features
      title: AlgorithmDocs
      description: Documentation for a scoring algorithm.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FeatureDoc:
      properties:
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        coefficient:
          type: number
          title: Coefficient
        url:
          type: string
          title: Url
      type: object
      required:
      - description
      - coefficient
      - url
      title: FeatureDoc
      description: Documentation for a particular feature in the matching API model.
    Algorithm:
      properties:
        name:
          type: string
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        features:
          additionalProperties:
            $ref: '#/components/schemas/FeatureDoc'
          type: object
          title: Features
          description: Deprecated, use `docs` instead
          deprecated: true
        docs:
          $ref: '#/components/schemas/AlgorithmDocs'
      type: object
      required:
      - name
      - features
      - docs
      title: Algorithm