Common filter parameters
Using fund_code vs fund_id
Bothfund_code and fund_id identify the same fund, but fund_code is a human-readable string (e.g. OJB) while fund_id is an opaque integer. Use fund_code when you are working interactively or constructing URLs by hand — it is stable across environments and easier to read in logs.
fund_code takes precedence.
Filtering by period
Theperiod parameter performs a prefix match on the period string stored for each document or value. This means you can filter at any level of granularity — year, quarter, or full period string.
Period strings are stored as-is from the MKK disclosure data. Common formats include
YYYY, YYYY-QN, and YYYY-MM. Pass the prefix that matches the granularity you need.Text search with the q parameter
Use theq parameter on the /documents, /sections, and /line-items endpoints to search by label or text content. The search is case-insensitive and matches partial strings.
Filtering line item values by section and slug
On/line-item-values (and its alias /key-values), use section_id to restrict results to a specific section of a document, and line_item_slug to retrieve values for a specific line item across all documents or periods.
label with other filters to match values by their display label:
Filtering portfolio entries
Use/portfolio-entries with fund_code, period, and section to find holdings for a given fund and period.
Pagination
All list endpoints return atotal field alongside the data array. Use limit and offset together to page through results.
funds, documents, line_items, portfolio_entries, etc.).
Use total to determine how many pages exist: ceil(total / limit). Keep incrementing offset by limit until offset >= total.
Per-endpoint limits
Paginating embedded portfolio in fund detail
When usinginclude_portfolio=true on GET /funds/{fundId}, the embedded portfolio list is paginated with its own portfolio_limit and portfolio_offset parameters — separate from the top-level limit and offset.
portfolio_entry_count field at the fund level indicating the full count of portfolio entries for that fund, and portfolio_limit/portfolio_offset reflecting the pagination applied to the embedded array.