Generated by API Evangelist
Written by API Evangelist tooling for Uphold's API. It is a proposal applied on top of the contract, not a document Uphold publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Core Statements API
version: 1.0.0
extends: openapi/uphold-statements-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 2
- target: $.paths['/core/statements/portfolio'].get
update:
x-apievangelist-phrasing:
intent: Get a portfolio statement for a period
effect: read
questions:
- How do I get my monthly portfolio statement?
- Can I pull a portfolio statement for a specific month and year?
instructions:
- text: Get my {period} portfolio statement for {month} {year}.
slots:
period: query.period
month: query.month
year: query.year
- text: Download the portfolio statement for {month}/{year} valued in {denomination}, period {period}.
slots:
month: query.month
year: query.year
denomination: query.denomination
period: query.period
method: generated
generated: '2026-09-26'
- target: $.paths['/core/statements/transactions'].get
update:
x-apievangelist-phrasing:
intent: Get a transactions statement for a period
effect: read
questions:
- Where can I get a statement of all my transactions for a month?
- Can I get a transaction statement for a given year and month?
instructions:
- text: Get my {period} transactions statement for {month} {year}.
slots:
period: query.period
month: query.month
year: query.year
- text: Pull the transactions statement for {month}/{year}, period {period}.
slots:
month: query.month
year: query.year
period: query.period
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.