Pier Finance Python API Docs | dltHub

Build a Pier Finance-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Pier Finance is an API platform that provides lending, payments, and credit facility services (loan origination, payments, compliance/coverage checks, and facility management) via REST endpoints. The REST API base URL is https://sandbox.pier-finance.com/api (sandbox) and https://production.pier-finance.com/api (production) and All requests require a Bearer JWT token obtained from the /token endpoint..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Pier Finance data in under 10 minutes.


What data can I load from Pier Finance?

Here are some of the endpoints you can load from Pier Finance:

ResourceEndpointMethodData selectorDescription
coverage_check_offers/coverage/check_offersPOST(response is an object map; not an array)Check a list of offers for compliance by state (returns map of id->result)
payments/paymentsPOST(single object)Submit a loan payment (returns Payment object)
configuration_lending_details/configuration/lending_detailsPOST(object)Set lender details (Starter Mode)
auth_get_token/tokenPOST{ token: string }Exchange client_id and secret for a JWT token
applications_list/applicationsGET(response is a top-level array or list object — use clients' OpenAPI client borrowers example shows clients call borrowersListAllBorrowers returning list in body)List applications (list endpoint; authenticated)
borrowers_list/borrowersGET(top-level array or list object)List borrowers

How do I authenticate with the Pier Finance API?

Obtain a JWT by POSTing client_id and secret to POST /token; include the token in Authorization: Bearer for all subsequent requests.

1. Get your credentials

  1. Request sandbox access or create an account via Pier (see Request Sandbox Access). 2) In the Pier dashboard or onboarding flow obtain your client_id and secret (sandbox keys are prefixed test_, production keys prod_). 3) Use these in a POST to /token to receive a JWT; store the token for Authorization header use.

2. Add them to .dlt/secrets.toml

[sources.pier_finance_source] client_id = "your_client_id_here" secret = "your_secret_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.


How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Pier Finance API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

python pier_finance_pipeline.py

If everything is configured correctly, you'll see output like this:

Pipeline pier_finance_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset pier_finance_data The duckdb destination used duckdb:/pier_finance.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

dlt pipeline pier_finance_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.


Python pipeline example

This example loads coverage/check_offers and payments from the Pier Finance API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def pier_finance_source(token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://sandbox.pier-finance.com/api (sandbox) and https://production.pier-finance.com/api (production)", "auth": { "type": "bearer", "token": token, }, }, "resources": [ {"name": "payments", "endpoint": {"path": "payments"}}, {"name": "coverage_check_offers", "endpoint": {"path": "coverage/check_offers"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="pier_finance_pipeline", destination="duckdb", dataset_name="pier_finance_data", ) load_info = pipeline.run(pier_finance_source()) print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.


How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("pier_finance_pipeline").dataset() sessions_df = data.payments.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM pier_finance_data.payments LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("pier_finance_pipeline").dataset() data.payments.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.


What destinations can I load Pier Finance data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.


Troubleshooting

Authentication failures

If the /token call fails or returns 401, verify client_id and secret are correct and that you are using the correct environment (sandbox vs production). The /token endpoint returns a JSON token field; subsequent requests must send Authorization: Bearer .

Rate limits

Pier's rate limit is 1,000 requests per minute for both sandbox and production. When you receive HTTP 429, back off and retry with exponential backoff. Only retry 5xx and 429 responses.

Error format

Pier returns structured error objects with keys error_type, error_code, error_message and optional error_detail (array of objects with value, msg, param, location). Use these fields to surface user-facing messages and debugging details.

Notes and caveats: The Pier docs are an OpenAPI-driven site; many endpoints are POST-only (coverage check, payments, configuration). For GET endpoints the OpenAPI client examples (generated SDK) show list endpoints (borrowersListAllBorrowers, applications listing) returning lists in the response body — confirm the exact list key by inspecting the specific endpoint response in the OpenAPI spec or calling the endpoint in your environment.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.


Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Pier Finance?

Request dlt skills, commands, AGENT.md files, and AI-native context.