payoff APIpayoff.ch ↗
Access 177,000+ Swiss structured financial products from payoff.ch. Search by issuer, category, and exchange. Retrieve terms, market data, and underlyings by ISIN.
What is the payoff API?
The payoff.ch API covers 177,000+ structured financial products across five SVSP categories — Capital Protection, Yield Enhancement, Participation, Credit Risk, and Leverage — via three endpoints. Use search_products to filter and paginate the full product catalog, get_product_detail to pull complete terms, market data, key figures, and underlying instruments for a specific ISIN, and get_filter_options to discover every valid filter value with live product counts.
curl -X GET 'https://api.parse.bot/scraper/e15ba936-6e49-4751-8934-eba9b7399c0e/search_products?page=1&language=en&categories=11' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace payoff-ch-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: Payoff.ch Structured Products SDK — search, filter, drill-down."""
from parse_apis.payoff_ch_structured_products_api import (
Payoff, Category, AssetClass, SortDirection, Language, ProductNotFound
)
client = Payoff()
# Discover available filters and total product count.
catalog = client.filtercatalogs.get(language=Language.EN)
print(f"Total products: {catalog.total_products}")
print(f"Categories: {len(catalog.categories)}, Issuers: {len(catalog.issuers)}")
# Search Yield Enhancement products, sorted by maturity date descending.
for product in client.productsummaries.search(
categories=Category.YIELD_ENHANCEMENT,
sort_by="lastTradingDate",
sort_dir=SortDirection.DESC,
limit=3,
):
print(product.name, product.issuer_name, product.last_trading_date)
# Drill into the first result's full detail via the summary's navigation op.
summary = client.productsummaries.search(
categories=Category.CAPITAL_PROTECTION,
asset_classes=AssetClass.EQUITIES,
limit=1,
).first()
if summary:
detail = summary.details()
print(detail.name, detail.trading_currency_code)
for underlying in detail.underlyings:
print(f" {underlying.name} ({underlying.symbol}): last={underlying.last}")
# Typed error handling: attempt to fetch a non-existent ISIN.
try:
client.products.get(isin="CH0000000000")
except ProductNotFound as exc:
print(f"Product not found: {exc.isin}")
print("exercised: filtercatalogs.get / productsummaries.search / details / products.get")
Full-text and filter-based search across all structured products. Returns 20 products per page with pagination metadata. Page 1 additionally includes filter counters showing how many products match each filter value. Paginates via integer page counter. Each product summary exposes ISIN for drill-down into full detail via get_product_detail.
| Param | Type | Description |
|---|---|---|
| page | integer | Page number (1-based). 20 products per page. |
| issuers | string | Issuer ref code (e.g., 'UBS', 'VT' for Vontobel, 'BAER' for Julius Bär). Use get_filter_options for all codes. |
| sort_by | string | Sort field (e.g., 'lastTradingDate'). |
| language | string | Language code. |
| sort_dir | string | Sort direction. |
| callables | string | Callable filter. |
| exchanges | string | Exchange filter ref code. |
| categories | string | Category filter ref code. |
| currencies | string | Currency filter code (e.g., 'CHF', 'EUR', 'USD'). Use get_filter_options for all codes. |
| guarantors | string | Guarantor ref code. Use get_filter_options for all codes. |
| maturities | string | Maturity filter. |
| underlying | string | Underlying search term (e.g., 'Nestle', 'SMI'). |
| asset_classes | string | Asset class filter. |
| multiple_underlyings | string | Single or multiple underlyings: '0' for single, '1' for multiple. |
{
"type": "object",
"fields": {
"page": "integer, current page number",
"counters": "object with filter counts (page 1 only)",
"per_page": "integer, products per page (20)",
"products": "array of product summary objects with isin, symbol, name, issuerName, categoryName, tradingCurrencyCode, lastTradingDate, ask",
"total_pages": "integer, total available pages",
"total_records": "integer, total matching products"
}
}About the payoff API
What the API covers
All three endpoints draw from the payoff.ch product finder, which indexes structured products listed on Swiss exchanges including SIX (XQMH), BX Swiss (XBRN), and Swiss DOTS (DOTS). Products span SVSP category codes 11 through 15 (Capital Protection, Yield Enhancement, Participation, Credit Risk, Leverage). Each product carries an ISIN and valor number that serve as stable identifiers across endpoints.
Searching and filtering with search_products
search_products accepts filters for issuers (ref codes like UBS, VT for Vontobel, BAER for Julius Bär), categories, exchanges, callables, and sort controls (sort_by, sort_dir). Results are paginated at 20 products per page; page 1 includes a counters object showing how many products match each active filter dimension. Pages 2 and beyond return the same product array fields: isin, symbol, name, issuerName, categoryName, tradingCurrencyCode, lastTradingDate, and ask. The total_records and total_pages fields on every response let you iterate the full result set programmatically.
Retrieving product detail with get_product_detail
Pass any active ISIN to get_product_detail to receive a structured object with seven distinct data groups: basic (isin, valor, symbol, termsheet URLs), terms (strikeRate, barrierRate, lastTradingDate, issuerName, categoryName), market_data (bid, ask, last, performance), key_figures (daysToMaturity, barrierHitProbMaturity), highlights, events, and underlyings. The underlyings array lists each underlying instrument with its own ISIN, name, strikeLevel, and last price. A similar_products array is also returned. If the ISIN is delisted or invalid, the response includes a stale_input object with kind input_not_found rather than an error.
Discovering filter values with get_filter_options
get_filter_options returns the full taxonomy used by search_products: categories, subcategories, issuers, exchanges, currencies, asset_classes, maturities, guarantors, and callables. Each entry includes a ref (the code to pass as a filter), a human-readable name, and a num count of matching products. The total_products field reflects the live catalog size. Both en and de language codes are accepted across all endpoints.
The payoff API is a managed, monitored endpoint for payoff.ch — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when payoff.ch changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official payoff.ch API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Screen for barrier reverse convertibles from a specific issuer by combining
issuersandcategoriesfilters insearch_products - Build a maturity calendar by sorting
search_productsresults bylastTradingDateascending across the full product set - Monitor barrier proximity for capital-at-risk products by polling
get_product_detailforbarrierRateandbarrierHitProbMaturity - Populate an issuer or category dropdown in a filter UI using
refandnumvalues fromget_filter_options - Fetch termsheet URLs and underlying instrument details for a watchlist of ISINs via
get_product_detail - Compare ask prices and performance across similar structured products using the
similar_productsarray andmarket_datafields - Identify callable vs. non-callable products on a specific exchange by combining
callablesandexchangesfilters
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does payoff.ch offer an official developer API?+
What does `get_product_detail` return for a delisted or invalid ISIN?+
stale_input object with kind set to input_not_found. ISINs must be active and obtainable from search_products; the endpoint does not return historical data for delisted products.Does the API cover structured products listed outside Switzerland?+
How does pagination work in `search_products`, and is there a difference between page 1 and later pages?+
total_records and total_pages for iteration. Page 1 additionally includes a counters object containing per-filter match counts, which is useful for building faceted filter UIs. Pages 2 and beyond omit counters but are otherwise identical in structure.Can I retrieve historical price time-series data for a structured product?+
get_product_detail returns current market data fields (bid, ask, last, performance) and computed figures like daysToMaturity and barrierHitProbMaturity, but no historical price series. You can fork this API on Parse and revise it to add a historical data endpoint if payoff.ch exposes that data elsewhere on the site.