What can you build?
Originator Workflows
Submit loan tapes, run eligibility checks, manage pools, and track deals through review and approval
Investor Workflows
Browse the deal marketplace, allocate to tranches, and monitor portfolio performance in real time
Event-Driven Integrations
React to platform events — deal approvals, trade settlements, SC completions — via webhooks
Analytics & Reporting
Run ALM analysis including duration, convexity, NII sensitivity, and stress testing on any deal
Quickstart
1. Get a Token
Contact support@9squid.com to obtain your Bearer token. All API requests require it.
2. Create a Deal
Initiate a loan tape upload, push your CSV or XLSX, and submit the deal for review in three API calls
3. Run Selection Criteria
Validate your deal against underwriting eligibility rules and inspect any exceptions
4. Explore the Reference
Browse all ~40 endpoints with full request schemas, response shapes, and live try-it-out
Recipes
Step-by-step guides for common integration patterns.Create a Deal
Initiate → Upload → Complete. Full originator loan tape submission flow with status lifecycle
Run Selection Criteria
Trigger an eligibility run, fetch results per deal, and drill into exception detail
Bulk Loan Upload
Submit multiple loan tapes in one job — per-deal upload URLs with independent status tracking
ALM Analytics
Run duration, convexity, NII sensitivity, EVE, VaR, and stress tests on any deal
Pool Analytics
Inspect aggregate pool statistics — weighted averages, delinquency breakdown, geographic distribution
Investor Deal Subscription
Browse the marketplace, submit IOI, commit to a subscription, and track allocation status
Investor Portfolio Reports
Fetch current holdings, trade history, tranche performance metrics, and pool analytics
Webhooks
Subscribe, verify signatures, replay failed deliveries — full event-driven integration guide
Base URL
Authentication
All requests require a Bearer token in theAuthorization header.
Rate Limits
The API enforces a limit of 100 requests per 60 seconds per token. Every response includes rate limit headers so you can monitor your usage:
When the limit is exceeded the API returns
429 Too Many Requests with a Retry-After header. Wait for the specified duration before retrying. See the Error Handling guide for a retry strategy.
Standard Response Format
Every response — success or error — follows the same envelope. SuccessRole-Based Access
Your token is scoped to a role. Calling an endpoint outside your role returns403 Forbidden.
Recent Releases
Platform API Gateway
Unified entry point for all Originator and Investor workflows — single base URL, consistent response format
Bulk Loan Tape Upload
Submit multiple loan tapes in one job with per-deal upload URLs and independent status tracking
Webhooks
Subscribe to real-time platform events — deal updates, loan approvals, trade settlements, SC completions
Investor Portfolio Reports
Holdings, trade history, tranche performance analytics, and pool metrics in a single endpoint
ALM Analytics
TCT Risk ALM analysis — duration, convexity, NII sensitivity, and stress testing on any deal
Deal Room Documents
Generic document upload supporting W9 forms, with additional document types coming soon
Support
- API access / tokens: support@9squid.com
- Platform: app.9squid.com
- API Reference: Platform API Gateway
- Service Status: status.9squid.com
- CLI: 9Squid/cli-releases — see the 9squid CLI guide