Skip to content

API Configuration

OpenAPI specification, client configuration, and support information.

Specification

OpenAPI Specification: openapi.yaml

The REST API is fully documented in OpenAPI 3.0 format. Use this for: - HTTP endpoint definitions - Request/response schemas - API status codes and error handling

Client Configuration

Timeout

All query functions accept an optional timeout parameter (in seconds):

from credigraph import query, CrediGraphClient

# Function level
result = query("apnews.com", timeout=15)

# Client level
client = CrediGraphClient(timeout=15)
result = client.query("apnews.com")

Default: 10 seconds

Health Checks

Check API health before querying:

import requests
from credigraph import CrediGraphClient

client = CrediGraphClient()
response = requests.post(f"{client.api_url}/health")
# {"status": "ok", "api_version": "0.4.1"}

Development

Support