cURL
curl --request GET \
--url https://api.yoshi.ai/v1/me/summary \
--header 'Authorization: Bearer <token>'import os
from yoshi_sdk import Yoshi
client = Yoshi(
api_key=os.environ.get("YOSHI_API_KEY"), # This is the default and can be omitted
)
response = client.me.summary()
print(response.data)import Yoshi from '@yoshi-ai/sdk';
const client = new Yoshi({
apiKey: process.env['YOSHI_API_KEY'], // This is the default and can be omitted
});
const response = await client.me.summary();
console.log(response.data);package main
import (
"context"
"fmt"
"github.com/yoshi-ai-dev/yoshi-go"
"github.com/yoshi-ai-dev/yoshi-go/option"
)
func main() {
client := yoshi.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Me.Summary(context.TODO(), yoshi.MeSummaryParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
yoshi me summary \
--api-key 'My API Key'{
"data": {
"accounts": {
"total": 123,
"items": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"subtype": "<string>",
"balance_available": 123,
"balance_current": 123,
"balance_limit": 123,
"status": "<string>",
"institution_name": "<string>",
"hidden": true
}
]
},
"scores": {
"observation_date": "<string>",
"yoshi": 123,
"recovery": 123,
"capacity": 123,
"baseline": 123
},
"goals": [
{
"id": "<string>",
"name": "<string>",
"goal_type": "<string>",
"status": "<string>",
"target_amount": 123,
"current_value": 123,
"target_date": "<string>"
}
]
},
"meta": {
"request_id": "req_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"timestamp": "2026-04-10T12:00:00.000Z"
}
}User
Get financial summary
Get a comprehensive financial summary including accounts, scores, and goals.
GET
/
me
/
summary
cURL
curl --request GET \
--url https://api.yoshi.ai/v1/me/summary \
--header 'Authorization: Bearer <token>'import os
from yoshi_sdk import Yoshi
client = Yoshi(
api_key=os.environ.get("YOSHI_API_KEY"), # This is the default and can be omitted
)
response = client.me.summary()
print(response.data)import Yoshi from '@yoshi-ai/sdk';
const client = new Yoshi({
apiKey: process.env['YOSHI_API_KEY'], // This is the default and can be omitted
});
const response = await client.me.summary();
console.log(response.data);package main
import (
"context"
"fmt"
"github.com/yoshi-ai-dev/yoshi-go"
"github.com/yoshi-ai-dev/yoshi-go/option"
)
func main() {
client := yoshi.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Me.Summary(context.TODO(), yoshi.MeSummaryParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
yoshi me summary \
--api-key 'My API Key'{
"data": {
"accounts": {
"total": 123,
"items": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"subtype": "<string>",
"balance_available": 123,
"balance_current": 123,
"balance_limit": 123,
"status": "<string>",
"institution_name": "<string>",
"hidden": true
}
]
},
"scores": {
"observation_date": "<string>",
"yoshi": 123,
"recovery": 123,
"capacity": 123,
"baseline": 123
},
"goals": [
{
"id": "<string>",
"name": "<string>",
"goal_type": "<string>",
"status": "<string>",
"target_amount": 123,
"current_value": 123,
"target_date": "<string>"
}
]
},
"meta": {
"request_id": "req_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"timestamp": "2026-04-10T12:00:00.000Z"
}
}Authorizations
A Yoshi API key from Settings → API Keys, or a Yoshi OAuth access token issued by Sign in with Yoshi.
Query Parameters
Available options:
true, false Response
200 - application/json
Financial summary retrieved.
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Last modified on June 18, 2026
Was this page helpful?