Sign in
POST/assistantComing soon

Ask Penny

DepositScout's savings assistant. Coming soon.

View as Markdown
All endpoints

Cost

10 DS Credits

per request

Scope

assistant

Same data as

/api/savings-assistant

the DepositScout website

This endpoint is in the catalogue so you can plan for it, but it isn't live yet. Calling it returns 404 not_found. Watch the changelog.

Request

POST https://depositscout.com/api/developer/v1/assistant

No parameters.

Example

shell
curl -X POST "https://depositscout.com/api/developer/v1/assistant" \
  -H "Authorization: Bearer $DS_API_KEY"

Try it

Runs against this site. A ds_test_ key is free and returns sample data in the real shape; a live key returns real data and spends credits. The key is kept in this tab only.

This endpoint isn't live yet, so there is nothing to call.

Response

data is a single object. Every 2xx also sets X-DS-Request-Id, X-DS-Credits-Charged, X-DS-Credits-Balance, the X-RateLimit-* trio and an ETag.

response.json
{
  "data": {
    "…": "the item"
  },
  "meta": {
    "requestId": "req_7f3a9c2d1b4e5a6f7c8d",
    "generatedAt": "2026-09-21T09:00:00.000Z",
    "creditsCharged": 10,
    "creditsBalance": 199,
    "attribution": "Rates powered by DepositScout — depositscout.com"
  }
}

Errors follow the shared error contract. Back to all endpoints.