API Overview

API overview

Python SDK

You can install the Python SDK with pip:

pip install fixpoint

There are two types of clients, the FixpointClient and the AsyncFixpointClient. The async client makes uses Python async / await, and is better for scaleable data workloads. FixpointClient is a little easier to local experimentation or if you are not using the asyncio framework.

Setting up your Fixpoint client:

# your API clients
from fixpoint.client import FixpointClient, AsyncFixpointClient
 
client = FixpointClient(
    # Can also set the FIXPOINT_API_KEY, in which case this is optional
    api_key="your-api-key",
    # Optionally configure the timeout. Defaults to 5.0 seconds.
    api_timeout=30.0,
)
 
# These are your extraction APIx
fixpoint.extractions
# Parsing APIs
fixpoint.parses
# For working with research records and documents
fixpoint.research

Fixpoint-specific errors are defined in fixpoint.errors and API request/response types are defined in fixpoint.client.types.

RESTful HTTP API

The Fixpoint API is a RESTful, resource-oriented HTTP API. API links:

Getting StartedExtraction