betteroff-finance UX API
The ux API from betteroff-finance — 1 operation(s) for ux.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/betteroff-finance:betteroff-finance-ux-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: BetterOff UX API
version: 0.5.0+cd65185c
servers:
- url: https://api.betteroff.finance
tags:
- name: ux
paths:
/ux/events:
post:
operationId: postUxEvents
tags:
- ux
security:
- session: []
requestBody:
required: true
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
anyOf:
- type: object
properties:
event:
type: string
enum:
- surface.viewed
- action.started
- action.succeeded
- action.failed
- action.cancelled
- client.error
- api.error_shown
- interaction.latency
- web_vital.recorded
- empty_state.seen
consentBasis:
type: string
enum:
- product_analytics
- operational
idempotencyKey:
type: string
pattern: ^[A-Za-z0-9_.:-]{1,160}$
route:
type: string
minLength: 1
maxLength: 240
surface:
type: string
maxLength: 80
action:
type: string
maxLength: 80
status:
type: string
enum:
- ok
- error
- cancelled
- warning
value:
type: integer
minimum: 0
maximum: 86400000
durationMs:
type: integer
minimum: 0
maximum: 86400000
errorClass:
type: string
maxLength: 120
digest:
type: string
pattern: ^[A-Za-z0-9_-]{1,64}$
release:
type: string
maxLength: 120
metadata:
type: object
propertyNames:
type: string
minLength: 1
maxLength: 48
additionalProperties:
anyOf:
- type: string
maxLength: 160
- type: number
- type: boolean
- type: 'null'
required:
- event
- consentBasis
- type: object
properties:
identity:
type: object
properties:
userId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
householdId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
required:
- userId
- householdId
events:
minItems: 1
maxItems: 20
type: array
items:
type: object
properties:
event:
type: string
enum:
- surface.viewed
- action.started
- action.succeeded
- action.failed
- action.cancelled
- client.error
- api.error_shown
- interaction.latency
- web_vital.recorded
- empty_state.seen
consentBasis:
type: string
enum:
- product_analytics
- operational
idempotencyKey:
type: string
pattern: ^[A-Za-z0-9_.:-]{1,160}$
route:
type: string
minLength: 1
maxLength: 240
surface:
type: string
maxLength: 80
action:
type: string
maxLength: 80
status:
type: string
enum:
- ok
- error
- cancelled
- warning
value:
type: integer
minimum: 0
maximum: 86400000
durationMs:
type: integer
minimum: 0
maximum: 86400000
errorClass:
type: string
maxLength: 120
digest:
type: string
pattern: ^[A-Za-z0-9_-]{1,64}$
release:
type: string
maxLength: 120
metadata:
type: object
propertyNames:
type: string
minLength: 1
maxLength: 48
additionalProperties:
anyOf:
- type: string
maxLength: 160
- type: number
- type: boolean
- type: 'null'
required:
- event
- consentBasis
required:
- events
responses:
'200':
description: Success
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Post ux events
x-summary-source: derived
components:
schemas:
ProblemDetails:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
type:
type: string
description: Always "about:blank"; branch on `code`.
title:
type: string
status:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
detail:
type: string
code:
type: string
description: Stable UPPER_SNAKE code.
error:
type: string
description: Older clients' copy of `detail`.
message:
type: string
description: Older clients' copy of `detail`.
requestId:
description: Diagnostic only; quote it to support.
type: string
instance:
type: string
details:
type: object
propertyNames:
type: string
additionalProperties: {}
required:
- type
- title
- status
- detail
- code
- error
- message
additionalProperties: {}
description: RFC 9457 problem details. Some refusals add fields; ignore ones you don't know.
securitySchemes:
session:
type: http
scheme: bearer
description: 'The BetterOff app acting for its signed-in user. Not available to integrations: Better Auth session tokens and browser session cookies are rejected. Use an API token or agent OAuth.'
apiToken:
type: http
scheme: bearer
description: Personal API token (bo_pat_), created in BetterOff settings with the scopes it may use.
agentOAuth:
type: openIdConnect
openIdConnectUrl: https://app.betteroff.finance/api/auth/.well-known/openid-configuration
description: Agent OAuth grant; the same token and scopes as /mcp.