# Patternode for developers

> Integrate with Patternode. Build and test against the mock (mock/mock_patternode.py) first; the specs at /specs/ are the contract; never put an API key in code, a file, a log or a chat.

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [Create a key](https://developers.patternode.com/api/create-key.md): The response is the only time the key is shown. Store it in your secret store
- [Segment a large file from your storage, as a job](https://developers.patternode.com/api/create-segmentation-job.md): For bodies over 5 MB and backfills. The file stays in your storage: give a link
- [Delete a key (permanent)](https://developers.patternode.com/api/delete-key.md): A key cannot delete itself. Use another admin key.
- [Disable a key (reversible)](https://developers.patternode.com/api/disable-key.md): Disable a key (reversible)
- [Enable a disabled key](https://developers.patternode.com/api/enable-key.md): Enable a disabled key
- [Extend many forming series in one request](https://developers.patternode.com/api/extend-series-batch.md): Up to 1,000 items, each an `extend` of one series with its own edge and bars,
- [Extend a forming series with new bars, from its edge](https://developers.patternode.com/api/extend-series.md): Patternode keeps nothing between calls. A forming series is carried by you: each
- [Balance, tier, limits and webhook URL](https://developers.patternode.com/api/get-account.md): Balance, tier, limits and webhook URL
- [A job's status, and its result link when done](https://developers.patternode.com/api/get-segmentation-job.md): A job's status, and its result link when done
- [Your service level indicators, as Patternode measures them](https://developers.patternode.com/api/get-service-levels.md): Your service level indicators, as Patternode measures them
- [Usage by key and kind, hourly or daily](https://developers.patternode.com/api/get-usage-report.md): Usage by key and kind, hourly or daily
- [OAuth 2.0 client credentials with private_key_jwt (Mission Critical, Dedicated)](https://developers.patternode.com/api/issue-token.md): RFC 6749 client credentials, the client authenticated by a JWT it signs (RFC 7523)
- [Every change to the account and its keys, and every support access](https://developers.patternode.com/api/list-audit-events.md): Every change to the account and its keys, and every support access
- [List the account's keys](https://developers.patternode.com/api/list-keys.md): List the account's keys
- [Patternode API](https://developers.patternode.com/api/patternode-api.md): Patternode keeps none of your series: no copies, no checkpoints, no results. A forming
- [Issue a new webhook signing secret](https://developers.patternode.com/api/rotate-webhook-secret.md): Shown once. Deliveries are signed with the new and the previous secret until the
- [Account](https://developers.patternode.com/api/schemas/account.md)
- [AccountUpdate](https://developers.patternode.com/api/schemas/accountupdate.md)
- [Bar](https://developers.patternode.com/api/schemas/bar.md): One interval of a series: [open_time, close_time, open, high, low, close]. Times are integers since the Unix epoch, UTC, in the request's time_unit...
- [CreatedKey](https://developers.patternode.com/api/schemas/createdkey.md)
- [Edge](https://developers.patternode.com/api/schemas/edge.md): A forming series' state, sealed by Patternode: encrypted, signed, and bound to your
- [Error](https://developers.patternode.com/api/schemas/error.md): Every error from /v1/ has this shape. Branch on error.details.error_code, never on the message.
- [ExtendRequest](https://developers.patternode.com/api/schemas/extendrequest.md)
- [Extension](https://developers.patternode.com/api/schemas/extension.md)
- [Job](https://developers.patternode.com/api/schemas/job.md)
- [JobRequest](https://developers.patternode.com/api/schemas/jobrequest.md)
- [Key](https://developers.patternode.com/api/schemas/key.md)
- [KeyIdentity](https://developers.patternode.com/api/schemas/keyidentity.md)
- [KeyRequest](https://developers.patternode.com/api/schemas/keyrequest.md)
- [Profile](https://developers.patternode.com/api/schemas/profile.md): The segmentation profile, optionally pinned to a version: `standard` or
- [RunUsage](https://developers.patternode.com/api/schemas/runusage.md)
- [Sample](https://developers.patternode.com/api/schemas/sample.md): One reading: [time, value]. Time since the Unix epoch, UTC, in the request's time_unit, strictly increasing within a series. Value finite and above...
- [Scope](https://developers.patternode.com/api/schemas/scope.md)
- [Segmentation](https://developers.patternode.com/api/schemas/segmentation.md)
- [SegmentationRequest](https://developers.patternode.com/api/schemas/segmentationrequest.md)
- [SegmentBox](https://developers.patternode.com/api/schemas/segmentbox.md): One segment of a series' tree, as a partner receives it: its place in the tree and its four vertices (open, high, low, close, each with its time). ...
- [SeriesName](https://developers.patternode.com/api/schemas/seriesname.md): A name you make up for the series. Patternode stores nothing else about it, so make
- [TimeUnit](https://developers.patternode.com/api/schemas/timeunit.md): The unit of every time in the request and the answer, since the Unix epoch, UTC.
- [UsageReport](https://developers.patternode.com/api/schemas/usagereport.md)
- [Segment a finished series in one call](https://developers.patternode.com/api/segment-series.md): Send a finished series as bars (or samples, which the service turns into bars).
- [Set the spend limit, auto-reload or webhook URL](https://developers.patternode.com/api/update-account.md): Set the spend limit, auto-reload or webhook URL
- [The key and its account](https://developers.patternode.com/api/whoami.md): The key and its account
- [Decisions you make](https://developers.patternode.com/architecture/decisions.md): The architecture decisions a partner makes when integrating, with the options, the recommended default and when to choose otherwise.
- [Deployment and resilience](https://developers.patternode.com/architecture/deployment.md): Where Patternode runs, where your callers should run, how traffic reaches it, what happens in a failure, and what your client must do.
- [Detailed flows](https://developers.patternode.com/architecture/flows.md): Sequence diagrams for engineers. Every call, retry, failover and event in each integration flow, and the life of a forming series.
- [Architecture overview](https://developers.patternode.com/architecture.md): The five-minute architecture view for enterprise and solution architects. What Patternode is from the outside, how it connects to your systems, and...
- [Integration architecture](https://developers.patternode.com/architecture/integration.md): The four integration styles, how they combine, the interfaces and transports behind them, and how the contract is governed.
- [Your side, the reference architecture](https://developers.patternode.com/architecture/partner-side.md): The building blocks a production integration needs on the partner side, what each must do, and the assumptions Patternode makes about your environm...
- [Flows for a fund](https://developers.patternode.com/architecture/quant/flows.md): Sequence diagrams for a fund's engineers. Backtest, going live from the backtest's edge, the intraday loop, and recovering an extender.
- [Quant fund architecture](https://developers.patternode.com/architecture/quant.md): The architecture views for a quantitative fund. How Patternode fits research, backtesting and live trading, from the CTO's view down to the enginee...
- [Live trading](https://developers.patternode.com/architecture/quant/live.md): The live path for a fund. Extending each instrument from its edge as its bar closes, keeping edges in memory and at rest, the latency budget, and w...
- [Operations and compliance](https://developers.patternode.com/architecture/quant/operations.md): Placement, capacity, blackout periods, resilience, support and the regulatory terms a fund needs, in one place.
- [Reproducibility](https://developers.patternode.com/architecture/quant/reproducibility.md): Profile versions for a fund. Why backtest and live agree, how to pin, and how to move to a new version with both side by side.
- [Research and backtest](https://developers.patternode.com/architecture/quant/research.md): How a fund's research platform uses Patternode jobs over its own storage, builds features from segments, backtests, and hands each series over to l...
- [Reference architectures](https://developers.patternode.com/architecture/reference-architectures.md): Two worked reference architectures, for utility operations and for quantitative trading, showing where Patternode sits among the systems you alread...
- [Security and data](https://developers.patternode.com/architecture/security.md): Trust boundaries, the controls at each, what data crosses and what never does, for security architects and reviewers.
- [Data boundary](https://developers.patternode.com/concepts/data-boundary.md): What Patternode receives, keeps and never sees, and how to name series so it learns nothing about your clients.
- [Products](https://developers.patternode.com/concepts/products.md): Delve, Essence, Sentinel and Foresight, what each is, and what each offers through the API today.
- [Requests, errors and limits](https://developers.patternode.com/concepts/requests.md): Authentication, the body hash on writes, idempotency, the error shape, rate limits and retries.
- [Shards and bars](https://developers.patternode.com/concepts/shards.md): What you send (bars), what you get back (segment boxes at every level), and how to read and draw them.
- [Versioning and status](https://developers.patternode.com/concepts/versioning.md): How the API changes, what x-status means, and how you hear about it.
- [account.balance_low](https://developers.patternode.com/events/account-balance-low.md): The credit balance fell below your threshold
- [Events](https://developers.patternode.com/events.md): Every event Patternode sends, on webhooks, subscriptions and event buses.
- [key.expiring](https://developers.patternode.com/events/key-expiring.md): A key expires within 7 days
- [segmentation.job.failed](https://developers.patternode.com/events/segmentation-job-failed.md): A segmentation job failed
- [segmentation.job.succeeded](https://developers.patternode.com/events/segmentation-job-succeeded.md): A segmentation job succeeded
- [Getting access](https://developers.patternode.com/get-started/access.md): The three ways in, from no account at all to production, what to send Patternode, and what happens next.
- [Getting your API keys](https://developers.patternode.com/get-started/api-keys.md): How Patternode issues keys to a partner, the three kinds, scopes and expiry, where to keep them, and how to rotate and revoke them.
- [The mock server](https://developers.patternode.com/get-started/mock-server.md): A local stand-in for the Patternode API, for development, tests and CI. Fake segments, real shapes and real checks.
- [Quickstart](https://developers.patternode.com/get-started/quickstart.md): Your first call, with a test key, against the mock or production, in curl, Python or TypeScript.
- [Production checklist](https://developers.patternode.com/go-live/production-checklist.md): Every line to tick before production traffic, grouped by area, with what each plan needs.
- [Troubleshooting](https://developers.patternode.com/go-live/troubleshooting.md): Symptoms, causes and fixes for the problems integrations meet most.
- [AWS with Terraform](https://developers.patternode.com/guides/aws-terraform.md): A Terraform module for the partner side on AWS: key vault, shard store, webhook receiver and the ingest policy.
- [Backfill](https://developers.patternode.com/guides/backfill.md): A job reads your file from your storage and writes the result back to it. Patternode keeps nothing.
- [Finished series](https://developers.patternode.com/guides/finished-series.md): Send a window of history once, store every level, draw from your store.
- [Forming series](https://developers.patternode.com/guides/forming-series.md): Send the edge with each new bar, store what comes back. Patternode keeps nothing between calls.
- [Integration patterns](https://developers.patternode.com/guides/integration-patterns.md): The four ways a partner system works with Delve, and how to choose.
- [Your segment store](https://developers.patternode.com/guides/segment-store.md): The library for your side. Keep what Patternode returns, query it by level and time, get a series' forward edge, and carry a forming series on with...
- [Receiving webhooks](https://developers.patternode.com/guides/webhooks.md): Verify the Standard Webhooks signature, deduplicate, answer at once, then work.
- [Patternode for developers](https://developers.patternode.com/docs.md): Integrate with Patternode's products. Delve first, formerly Mosaic, the shards toolkit.
- [Finance](https://developers.patternode.com/industries/finance.md): Trades, quotes and bars into Delve, for quantitative research, backtests and live trading.
- [Industries](https://developers.patternode.com/industries.md): The same API, with examples, data and guidance in the shape of your industry's data.
- [Utilities](https://developers.patternode.com/industries/utilities.md): Historian, SCADA and meter data into Delve, for monitoring products and control rooms in electricity, water and gas.
- [Delve onboarding playbook](https://developers.patternode.com/playbooks/delve-onboarding.md): From choosing a plan to production traffic at utility-operations or trading grade, in eleven stages with a gate at each.
- [Changelog](https://developers.patternode.com/resources/changelog.md): Changes to the API, the events, the profiles and this site.
- [For coding agents](https://developers.patternode.com/resources/for-agents.md): How a coding agent should use this site and repository to build a Patternode integration.
- [Compliance](https://developers.patternode.com/service/compliance.md): Assurance reports Patternode provides, and how the service supports the regimes utilities and funds work under.
- [The service contract](https://developers.patternode.com/service.md): What Patternode provides and what it needs from you, specified for real-time utility operations and high-volume quantitative trading.
- [Plans](https://developers.patternode.com/service/plans.md): Evaluation, Production, Mission Critical and Dedicated, and what each guarantees.
- [Real-time](https://developers.patternode.com/service/realtime.md): Nothing kept between calls, transports, batching, ordering, exactly-once effect, backpressure, time precision and determinism.
- [Resilience](https://developers.patternode.com/service/resilience.md): Jurisdictions and regions, failover, recovery objectives, degraded modes, change control, resilience testing and exit.
- [Security](https://developers.patternode.com/service/security.md): Authentication, private connectivity, encryption and keys you manage, audit, and how Patternode looks after the service.
- [Service levels](https://developers.patternode.com/service/service-levels.md): The service level objectives, how each is measured, the error budget and service credits.
- [Shared responsibility](https://developers.patternode.com/service/shared-responsibility.md): What Patternode is responsible for, and what you are.
- [Support](https://developers.patternode.com/service/support.md): Severities, response times, incident communication and post-incident reports.