Get a suggestion's review
Checks one suggestion again against the account as it is now and returns it with fresh review terms. Call it when the user opens a suggestion's review, then draw the review from review and confirm the move through the routes that make it. When the suggestion no longer holds (the account or the price moved, the user set it aside, or it cannot be made where the user is now), it answers 409 suggestion_changed: say it changed since Fin suggested it, and read the page's suggestions again.
Authentication
Both headers are required.
- Header:
X-Api-Key: YOUR_API_KEY - Header:
Authorization: Bearer YOUR_USER_TOKEN— A user's session token, from Create a session.
Path parameters
userIdstringrequiredYour id for the user: the userId you sent to Create a user. It must be the session's user.
Validation rules
- Pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
suggestionIdstring · uuidrequiredThe suggestion's id, from List suggestions.
Validation rules
- 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)$"
Query parameters
timeZonestringoptionalThe user's time zone as an IANA name, such as America/New_York: dates in titles, reasons and new schedules read in it. Without it they read in UTC, and Fin suggests no new schedule.
Validation rules
- Maximum length
64- Pattern
"^[A-Za-z][\\w+-]*(?:\\/[\\w+-]+)*$"
countrystringoptionalThe country the user is reading from, as an uppercase ISO 3166-1 alpha-2 code your server resolved, never the browser's word. A move on a tokenized stock shows only where stocks are available; without it, none shows.
Validation rules
- Pattern
"^[A-Z]{2}$"
perpsAllowedstringoptionaltrue when your app lets this user fund perpetuals where they are now; without it, no perps move shows.
Validation rules
- Allowed values
["true","false"]
Request example
Illustrative request. Replace the host, credentials and resource IDs with your own. If a request file is shown, create it from the schema above. Review the requested action before sending it.
curl --request GET 'https://api.example.test/v1/users/YOUR_USER_ID/suggestions/YOUR_SUGGESTION_ID/review' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Authorization: Bearer YOUR_USER_TOKEN'
Responses
200 The suggestion, checked again, with fresh terms.
The suggestion, checked again, with fresh terms.
application/json · object
One move Fin suggests on the user's own money, and the exact terms its review draws. Nothing moves until the user reviews and confirms it.
idstring · uuidrequiredThe suggestion's id. The same move in a later read keeps it.
Validation rules
- 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)$"
titlestringrequiredThe move, verb first, with its exact terms: Move your NEAR buy to $4.80.
Validation rules
- Minimum length
1- Maximum length
120
reasonstringrequiredWhy, in one sentence; Fin filled in every figure from the account.
Validation rules
- Minimum length
1- Maximum length
280
reviewoneOfrequiredThe exact terms a suggestion's review draws, keyed by kind: every id and asset the move needs, and the one figure − and + adjust.
Show attributes
The exact terms a suggestion's review draws, keyed by kind: every id and asset the move needs, and the one figure − and + adjust.
oneOf · 17 variants
Variant 1 · kind: swap
Swap now: what you pay against what you get.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"swap"
balanceobjectrequiredWhat you hold of the asset you pay with.
Show attributes
What you hold of the asset you pay with.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
buyobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
buyPriceUsdstringrequiredOne unit of the bought asset now.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
maxValueLossBpsintegerrequiredThe most the swap may lose, fees and price included.
Validation rules
- Minimum
0- Maximum
1000000
etaSecondsintegeroptionalFin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.
Validation rules
- Minimum
1- Maximum
86400
amountobjectrequiredHow much to swap.
Show attributes
How much to swap.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
payobjectrequiredWhat Get a swap quote sells, exactly.
Show attributes
What Get a swap quote sells, exactly.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
receiveobjectrequiredWhat it gets at today's price.
Show attributes
What it gets at today's price.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
receiveAtLeastobjectrequiredThe least it gets within the loss limit.
Show attributes
The least it gets within the loss limit.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 2 · kind: limit_order
A limit buy or sell: your price against the market.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"limit_order"
sidestringrequiredWhether it buys or sells the asset.
Validation rules
- Allowed values
["buy","sell"]
assetobjectrequiredThe asset the order buys or sells.
Show attributes
The asset the order buys or sells.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
marketPriceUsdstringrequiredOne unit of the asset now.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
spendobjectrequiredWhat a buy spends or a sell sells.
Show attributes
What a buy spends or a sell sells.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
holdingobjectoptionalA sell: what you hold of the asset.
Show attributes
A sell: what you hold of the asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
expiresInHoursintegerrequiredHow long the order rests.
Validation rules
- Minimum
1- Maximum
720
priceobjectrequiredYour price.
Show attributes
Your price.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
A limit order's price, with what depends on it.
limitPriceUsdstringrequiredYour price in dollars per one unit of the asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
toGoBpsintegerrequiredHow far the market must move to fill, from today; 0 fills at once.
Validation rules
- Minimum
0- Maximum
1000000
receiveobjectrequiredWhat the order gets at this price.
Show attributes
What the order gets at this price.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
orderobjectrequiredPrepare an order's request for this price, exactly.
Show attributes
Prepare an order's request for this price, exactly.
sellAssetIdstringrequiredThe asset to sell from the agent wallet: an assetId from Get balances.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
amountRawstringrequiredThe exact amount to sell, in the sold asset's smallest unit. It leaves the agent wallet when the order is placed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
buyAssetIdstringrequiredThe asset to buy: an id from List supported assets. What the order buys comes back to the agent wallet.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
limitPricestringrequiredThe least the order sells at, as bought-asset units per ONE sold unit, written as a plain decimal: "5" means at least 5 of the bought asset for each one sold. Never scale it by decimals.
Validation rules
- Maximum length
80- Pattern
"^(0|[1-9]\\d{0,38})(\\.\\d{1,38})?$"
expiresInHoursintegerrequiredHow long the order rests before it expires, in whole hours from 1 to 720 (30 days).
Validation rules
- Minimum
1- Maximum
720
contextobjectoptionalWhat your app knows about the user as they make this request. It applies to this request only, so send it with every request that may trade a tokenized stock.
Show attributes
What your app knows about the user as they make this request. It applies to this request only, so send it with every request that may trade a tokenized stock.
countrystringoptionalThe country the user is making this request from, as an uppercase ISO 3166-1 alpha-2 code such as GB, resolved by your server from the request (your edge's IP geolocation), never taken from the browser. A tokenized stock is traded only when this reports a country where it is available.
Validation rules
- Pattern
"^[A-Z]{2}$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 3 · kind: order_move
Move an order: cancel it and place the same order at a new price, or at its own price to renew it.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"order_move"
orderIdstring · uuidrequiredThe order's id, as List orders names it.
Validation rules
- 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)$"
sidestringrequiredWhether it buys or sells the asset.
Validation rules
- Allowed values
["buy","sell"]
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
marketPriceUsdstringrequiredOne unit of the asset now.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
spendobjectrequiredWhat the order spends or sells; the move keeps it.
Show attributes
What the order spends or sells; the move keeps it.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
currentobjectrequiredThe order as it rests now.
Show attributes
The order as it rests now.
limitPriceUsdstringrequiredIts price now.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
receiveobjectrequiredWhat it gets at that price.
Show attributes
What it gets at that price.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
expiresAtstring · date-timerequiredWhen it expires as it rests now.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
expiresInHoursintegerrequiredHow long the new order rests.
Validation rules
- Minimum
1- Maximum
720
priceobjectrequiredThe new price. An option at the current price renews the order as it is.
Show attributes
The new price. An option at the current price renews the order as it is.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
A limit order's price, with what depends on it.
limitPriceUsdstringrequiredYour price in dollars per one unit of the asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
toGoBpsintegerrequiredHow far the market must move to fill, from today; 0 fills at once.
Validation rules
- Minimum
0- Maximum
1000000
receiveobjectrequiredWhat the order gets at this price.
Show attributes
What the order gets at this price.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
orderobjectrequiredPrepare an order's request for this price, exactly.
Show attributes
Prepare an order's request for this price, exactly.
sellAssetIdstringrequiredThe asset to sell from the agent wallet: an assetId from Get balances.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
amountRawstringrequiredThe exact amount to sell, in the sold asset's smallest unit. It leaves the agent wallet when the order is placed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
buyAssetIdstringrequiredThe asset to buy: an id from List supported assets. What the order buys comes back to the agent wallet.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
limitPricestringrequiredThe least the order sells at, as bought-asset units per ONE sold unit, written as a plain decimal: "5" means at least 5 of the bought asset for each one sold. Never scale it by decimals.
Validation rules
- Maximum length
80- Pattern
"^(0|[1-9]\\d{0,38})(\\.\\d{1,38})?$"
expiresInHoursintegerrequiredHow long the order rests before it expires, in whole hours from 1 to 720 (30 days).
Validation rules
- Minimum
1- Maximum
720
contextobjectoptionalWhat your app knows about the user as they make this request. It applies to this request only, so send it with every request that may trade a tokenized stock.
Show attributes
What your app knows about the user as they make this request. It applies to this request only, so send it with every request that may trade a tokenized stock.
countrystringoptionalThe country the user is making this request from, as an uppercase ISO 3166-1 alpha-2 code such as GB, resolved by your server from the request (your edge's IP geolocation), never taken from the browser. A tokenized stock is traded only when this reports a country where it is available.
Validation rules
- Pattern
"^[A-Z]{2}$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 4 · kind: order_cancel
Cancel an order: what it was, and what comes back.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"order_cancel"
orderIdstring · uuidrequiredThe order's id, as List orders names it.
Validation rules
- 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)$"
sidestringrequiredWhether it buys or sells the asset.
Validation rules
- Allowed values
["buy","sell"]
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
spendobjectrequiredWhat the order spends or sells.
Show attributes
What the order spends or sells.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
limitPriceUsdstringrequiredIts price.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
placedAtstring · date-timerequiredWhen it was placed.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
filledBpsintegerrequiredHow much has filled: 0 is nothing.
Validation rules
- Minimum
0- Maximum
10000
returnsobjectrequiredWhat comes back to the account.
Show attributes
What comes back to the account.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
filledobjectoptionalWhat has filled and stays; omitted for none.
Show attributes
What has filled and stays; omitted for none.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
etaSecondsintegeroptionalFin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.
Validation rules
- Minimum
1- Maximum
86400
Variant 5 · kind: recurring_buy
A recurring buy: the runs your money covers.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"recurring_buy"
assetobjectrequiredWhat each run buys.
Show attributes
What each run buys.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
balanceobjectrequiredWhat each run spends from, and what you hold of it.
Show attributes
What each run spends from, and what you hold of it.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
scheduleobjectrequiredWhen a schedule runs, in the zone it keeps.
Show attributes
When a schedule runs, in the zone it keeps.
cadencestringrequiredHow often it runs.
Validation rules
- Allowed values
["daily","weekly","monthly"]
timestringrequiredLocal time of day, 24-hour: 09:00.
Validation rules
- Pattern
"^([01]\\d|2[0-3]):[0-5]\\d$"
weekdaystringoptionalA weekly schedule's day.
Validation rules
- Allowed values
["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]
dayOfMonthintegeroptionalA monthly schedule's day.
Validation rules
- Minimum
1- Maximum
28
timeZonestringrequiredThe IANA zone it keeps: Europe/London.
Validation rules
- Maximum length
64- Pattern
"^[A-Za-z][\\w+-]*(?:\\/[\\w+-]+)*$"
upcomingarrayrequiredThe next runs, first first.
Show attributes
The next runs, first first.
Validation rules
- Maximum items
8
Array items · string · date-time
An instant in RFC 3339, such as 2026-11-07T09:00:00Z.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
maxRunsintegerrequiredHow many buys it makes at most.
Validation rules
- Minimum
0- Maximum
100000
endsAtstring · date-timerequiredWhen it ends.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
maxValueLossBpsintegerrequiredThe most one buy may lose.
Validation rules
- Minimum
0- Maximum
1000000
askEachTimebooleanrequiredFin's pick for asking before each buy.
amountobjectrequiredWhat each run spends.
Show attributes
What each run spends.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
perRunanyOfrequiredWhat one run of an automation spends: an exact amount of an asset (1 USDC), or dollars of what it buys ($1 of NEAR). Fin works out every figure that follows from it either way.
Show attributes
What one run of an automation spends: an exact amount of an asset (1 USDC), or dollars of what it buys ($1 of NEAR). Fin works out every figure that follows from it either way.
anyOf · 2 variants
Variant 1 · object
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
Variant 2 · object
A dollar figure an automation spends.
usdstringrequiredDollars of what it buys: 1 reads $1 of NEAR.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
receiveEachobjectrequiredWhat each buy gets at today's price.
Show attributes
What each buy gets at today's price.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
runsCoveredintegerrequiredHow many of upcoming your balance pays for.
Validation rules
- Minimum
0- Maximum
100000
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 6 · kind: price_rule
Buy or sell once a price crosses a line.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"price_rule"
sidestringrequiredWhether it buys or sells the asset.
Validation rules
- Allowed values
["buy","sell"]
directionstringrequiredWhether it runs once the price drops below its line or rises above it.
Validation rules
- Allowed values
["below","above"]
assetobjectrequiredThe asset it watches and trades.
Show attributes
The asset it watches and trades.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
marketPriceUsdstringrequiredOne unit of the asset now.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
spendobjectrequiredWhat a buy spends or a sell sells.
Show attributes
What a buy spends or a sell sells.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
holdingobjectoptionalA sell: what you hold of the asset.
Show attributes
A sell: what you hold of the asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
historyobjectrequiredThe chart's line.
Show attributes
The chart's line.
fromstring · date-timerequiredAn instant in RFC 3339, such as 2026-11-07T09:00:00Z.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
tostring · date-timerequiredAn instant in RFC 3339, such as 2026-11-07T09:00:00Z.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
closesUsdarrayrequiredDaily closes, oldest first.
Show attributes
Daily closes, oldest first.
Validation rules
- Maximum items
400
Array items · string
US dollars as exact decimal text, such as 4.80 or 82732; never a float.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
maxRunsintegerrequiredHow many times it runs: 1 runs once.
Validation rules
- Minimum
0- Maximum
100000
checkEveryMinutesintegerrequiredHow often it checks the price.
Validation rules
- Minimum
1- Maximum
1440
endsAtstring · date-timerequiredWhen it ends.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
maxValueLossBpsintegerrequiredThe most it may lose when it runs.
Validation rules
- Minimum
0- Maximum
1000000
thresholdobjectrequiredThe price line.
Show attributes
The price line.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
thresholdUsdstringrequiredThe price that starts it.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
distanceBpsintegerrequiredHow far that is from today's price.
Validation rules
- Minimum
0- Maximum
1000000
receiveobjectrequiredA sell: the least it receives there; a buy: what it buys there.
Show attributes
A sell: the least it receives there; a buy: what it buys there.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 7 · kind: summary
A summary Fin writes on a schedule; no money moves.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"summary"
scheduleobjectrequiredWhen a schedule runs, in the zone it keeps.
Show attributes
When a schedule runs, in the zone it keeps.
cadencestringrequiredHow often it runs.
Validation rules
- Allowed values
["daily","weekly","monthly"]
timestringrequiredLocal time of day, 24-hour: 09:00.
Validation rules
- Pattern
"^([01]\\d|2[0-3]):[0-5]\\d$"
weekdaystringoptionalA weekly schedule's day.
Validation rules
- Allowed values
["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]
dayOfMonthintegeroptionalA monthly schedule's day.
Validation rules
- Minimum
1- Maximum
28
timeZonestringrequiredThe IANA zone it keeps: Europe/London.
Validation rules
- Maximum length
64- Pattern
"^[A-Za-z][\\w+-]*(?:\\/[\\w+-]+)*$"
previewstringrequiredA sample of the first summary, written by Fin from the account: plain text.
Validation rules
- Minimum length
1- Maximum length
600
threadstringrequiredThe page whose thread it writes in: home.
Validation rules
- Minimum length
1- Maximum length
64
timeobjectrequiredThe time of day it comes.
Show attributes
The time of day it comes.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
timestringrequiredLocal time of day, 24-hour.
Validation rules
- Pattern
"^([01]\\d|2[0-3]):[0-5]\\d$"
firstAtstring · date-timerequiredWhen the first one comes.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 8 · kind: deposit
Add money from the connected wallet.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"deposit"
assetobjectrequiredWhat is sent and on which chain.
Show attributes
What is sent and on which chain.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
roomobjectoptionalThe deposit limit, what the account holds against it, and what is left; omitted when no limit applies.
Show attributes
The deposit limit, what the account holds against it, and what is left; omitted when no limit applies.
limitUsdstringrequiredUS dollars as exact decimal text, such as 4.80 or 82732; never a float.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
usedUsdstringrequiredUS dollars as exact decimal text, such as 4.80 or 82732; never a float.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
leftUsdstringrequiredUS dollars as exact decimal text, such as 4.80 or 82732; never a float.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
networkFeeUsdstringoptionalFin's estimate of the sending chain's fee; omitted without one.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
etaSecondsintegeroptionalFin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.
Validation rules
- Minimum
1- Maximum
86400
amountobjectrequiredHow much to deposit.
Show attributes
How much to deposit.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
depositobjectrequiredAn exact amount of one asset.
Show attributes
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
usdstringrequiredIts worth now.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
leftAfterUsdstringoptionalWhat is left of the room after it; omitted when no limit applies.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 9 · kind: withdraw
Move money back to your own wallet.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"withdraw"
balanceobjectrequiredWhat you hold of the asset.
Show attributes
What you hold of the asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
destinationobjectoptionalYour own wallet, the only place a withdrawal goes, when Fin knows its address; otherwise your app's own connected wallet.
Show attributes
Your own wallet, the only place a withdrawal goes, when Fin knows its address; otherwise your app's own connected wallet.
addressstringrequiredThe wallet's address on its network.
Validation rules
- Pattern
"^[\\x21-\\x7e]{1,256}$"
networkstringrequiredThe network, as List supported assets names it.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
etaSecondsintegeroptionalFin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.
Validation rules
- Minimum
1- Maximum
86400
amountobjectrequiredHow much to withdraw.
Show attributes
How much to withdraw.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
withdrawobjectrequiredAn exact amount of one asset.
Show attributes
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
feeobjectoptionalThe fee, from a real quote; omitted without one.
Show attributes
The fee, from a real quote; omitted without one.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
arrivesAtLeastobjectoptionalThe least that arrives, from a real quote; omitted without one.
Show attributes
The least that arrives, from a real quote; omitted without one.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
staysobjectrequiredWhat stays in the account.
Show attributes
What stays in the account.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 10 · kind: send
Send to a saved contact. Fin does not suggest it yet.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"send"
contactIdstringrequiredYour app's contact.
Validation rules
- Minimum length
1- Maximum length
128
purposestringoptionalWhat it is for, in Fin's words.
Validation rules
- Maximum length
80
balanceobjectrequiredAn exact amount of one asset.
Show attributes
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
etaSecondsintegeroptionalFin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.
Validation rules
- Minimum
1- Maximum
86400
amountobjectrequiredHow much to send.
Show attributes
How much to send.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
sendobjectrequiredAn exact amount of one asset.
Show attributes
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
feeobjectoptionalAn exact amount of one asset.
Show attributes
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
arrivesAtLeastobjectoptionalAn exact amount of one asset.
Show attributes
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 11 · kind: perps_fund
Move margin to the perps account.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"perps_fund"
balanceobjectrequiredAn exact amount of one asset.
Show attributes
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
etaSecondsintegeroptionalFin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.
Validation rules
- Minimum
1- Maximum
86400
amountobjectrequiredHow much to move.
Show attributes
How much to move.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
moveobjectrequiredAn exact amount of one asset.
Show attributes
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 12 · kind: automation_pause
Pause an automation.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"automation_pause"
automationobjectrequiredAn automation a review changes.
Show attributes
An automation a review changes.
automationIdstring · uuidrequiredThe automation's id.
Validation rules
- 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)$"
namestringrequiredThe automation's own name, as its owner wrote it.
Validation rules
- Minimum length
1- Maximum length
120
triggerstringrequiredWhat starts its runs. An event one runs when something happens and has no price or time to draw.
Validation rules
- Allowed values
["schedule","price-drop","price-rise","event"]
assetobjectoptionalThe asset it buys or sells.
Show attributes
The asset it buys or sells.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
scheduleobjectoptionalA scheduled one's schedule.
Show attributes
A scheduled one's schedule.
cadencestringrequiredHow often it runs.
Validation rules
- Allowed values
["daily","weekly","monthly"]
timestringrequiredLocal time of day, 24-hour: 09:00.
Validation rules
- Pattern
"^([01]\\d|2[0-3]):[0-5]\\d$"
weekdaystringoptionalA weekly schedule's day.
Validation rules
- Allowed values
["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]
dayOfMonthintegeroptionalA monthly schedule's day.
Validation rules
- Minimum
1- Maximum
28
timeZonestringrequiredThe IANA zone it keeps: Europe/London.
Validation rules
- Maximum length
64- Pattern
"^[A-Za-z][\\w+-]*(?:\\/[\\w+-]+)*$"
nextRunAtstring · date-timeoptionalWhen it runs next, while it is on.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
pausedAtstring · date-timeoptionalWhen it was paused, when Fin can tell.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
upcomingarrayrequiredThe next runs it would make, all skipped while paused.
Show attributes
The next runs it would make, all skipped while paused.
Validation rules
- Maximum items
8
Array items · string · date-time
An instant in RFC 3339, such as 2026-11-07T09:00:00Z.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
coverageobjectrequiredWhat pays for a schedule's coming runs.
Show attributes
What pays for a schedule's coming runs.
byobjectrequiredThe money that pays: the spendable balance.
Show attributes
The money that pays: the spendable balance.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
byDepositbooleanrequiredTrue when that balance is there because a deposit landed since the last run.
runsCoveredintegerrequiredHow many of the coming runs it pays for; 0 pays for none.
Validation rules
- Minimum
0- Maximum
100000
runsLeftintegeroptionalRuns left before the automation ends.
Validation rules
- Minimum
0- Maximum
100000
Variant 13 · kind: automation_resume
Resume a paused automation under the approval it already has.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"automation_resume"
automationobjectrequiredAn automation a review changes.
Show attributes
An automation a review changes.
automationIdstring · uuidrequiredThe automation's id.
Validation rules
- 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)$"
namestringrequiredThe automation's own name, as its owner wrote it.
Validation rules
- Minimum length
1- Maximum length
120
triggerstringrequiredWhat starts its runs. An event one runs when something happens and has no price or time to draw.
Validation rules
- Allowed values
["schedule","price-drop","price-rise","event"]
assetobjectoptionalThe asset it buys or sells.
Show attributes
The asset it buys or sells.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
scheduleobjectoptionalA scheduled one's schedule.
Show attributes
A scheduled one's schedule.
cadencestringrequiredHow often it runs.
Validation rules
- Allowed values
["daily","weekly","monthly"]
timestringrequiredLocal time of day, 24-hour: 09:00.
Validation rules
- Pattern
"^([01]\\d|2[0-3]):[0-5]\\d$"
weekdaystringoptionalA weekly schedule's day.
Validation rules
- Allowed values
["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]
dayOfMonthintegeroptionalA monthly schedule's day.
Validation rules
- Minimum
1- Maximum
28
timeZonestringrequiredThe IANA zone it keeps: Europe/London.
Validation rules
- Maximum length
64- Pattern
"^[A-Za-z][\\w+-]*(?:\\/[\\w+-]+)*$"
nextRunAtstring · date-timeoptionalWhen it runs next, while it is on.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
pausedAtstring · date-timeoptionalWhen it was paused, when Fin can tell.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
upcomingarrayrequiredThe next runs, first first.
Show attributes
The next runs, first first.
Validation rules
- Maximum items
8
Array items · string · date-time
An instant in RFC 3339, such as 2026-11-07T09:00:00Z.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
coverageobjectrequiredWhat pays for a schedule's coming runs.
Show attributes
What pays for a schedule's coming runs.
byobjectrequiredThe money that pays: the spendable balance.
Show attributes
The money that pays: the spendable balance.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
byDepositbooleanrequiredTrue when that balance is there because a deposit landed since the last run.
runsCoveredintegerrequiredHow many of the coming runs it pays for; 0 pays for none.
Validation rules
- Minimum
0- Maximum
100000
runsLeftintegeroptionalRuns left before the automation ends.
Validation rules
- Minimum
0- Maximum
100000
endsAtstring · date-timerequiredWhen its approval ends.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
runsUsedintegerrequiredRuns it has made.
Validation rules
- Minimum
0- Maximum
100000
maxRunsintegerrequiredRuns its approval allows in all.
Validation rules
- Minimum
0- Maximum
100000
Variant 14 · kind: automation_end
End an automation: its history stays, its runs stop.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"automation_end"
automationobjectrequiredAn automation a review changes.
Show attributes
An automation a review changes.
automationIdstring · uuidrequiredThe automation's id.
Validation rules
- 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)$"
namestringrequiredThe automation's own name, as its owner wrote it.
Validation rules
- Minimum length
1- Maximum length
120
triggerstringrequiredWhat starts its runs. An event one runs when something happens and has no price or time to draw.
Validation rules
- Allowed values
["schedule","price-drop","price-rise","event"]
assetobjectoptionalThe asset it buys or sells.
Show attributes
The asset it buys or sells.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
scheduleobjectoptionalA scheduled one's schedule.
Show attributes
A scheduled one's schedule.
cadencestringrequiredHow often it runs.
Validation rules
- Allowed values
["daily","weekly","monthly"]
timestringrequiredLocal time of day, 24-hour: 09:00.
Validation rules
- Pattern
"^([01]\\d|2[0-3]):[0-5]\\d$"
weekdaystringoptionalA weekly schedule's day.
Validation rules
- Allowed values
["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]
dayOfMonthintegeroptionalA monthly schedule's day.
Validation rules
- Minimum
1- Maximum
28
timeZonestringrequiredThe IANA zone it keeps: Europe/London.
Validation rules
- Maximum length
64- Pattern
"^[A-Za-z][\\w+-]*(?:\\/[\\w+-]+)*$"
nextRunAtstring · date-timeoptionalWhen it runs next, while it is on.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
pausedAtstring · date-timeoptionalWhen it was paused, when Fin can tell.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
runsobjectrequiredRuns made of the runs approved.
Show attributes
Runs made of the runs approved.
doneintegerrequiredRuns it made.
Validation rules
- Minimum
0- Maximum
100000
totalintegerrequiredRuns its approval allowed.
Validation rules
- Minimum
0- Maximum
100000
stillCoveredobjectoptionalAnother automation of yours still watching the asset.
Show attributes
Another automation of yours still watching the asset.
sidestringrequiredWhether it buys or sells the asset.
Validation rules
- Allowed values
["buy","sell"]
directionstringrequiredWhether it runs below its line or above it.
Validation rules
- Allowed values
["below","above"]
thresholdUsdstringrequiredIts line.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
Variant 15 · kind: automation_change
Change what each run of an automation spends.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"automation_change"
automationobjectrequiredAn automation a review changes.
Show attributes
An automation a review changes.
automationIdstring · uuidrequiredThe automation's id.
Validation rules
- 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)$"
namestringrequiredThe automation's own name, as its owner wrote it.
Validation rules
- Minimum length
1- Maximum length
120
triggerstringrequiredWhat starts its runs. An event one runs when something happens and has no price or time to draw.
Validation rules
- Allowed values
["schedule","price-drop","price-rise","event"]
assetobjectoptionalThe asset it buys or sells.
Show attributes
The asset it buys or sells.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
scheduleobjectoptionalA scheduled one's schedule.
Show attributes
A scheduled one's schedule.
cadencestringrequiredHow often it runs.
Validation rules
- Allowed values
["daily","weekly","monthly"]
timestringrequiredLocal time of day, 24-hour: 09:00.
Validation rules
- Pattern
"^([01]\\d|2[0-3]):[0-5]\\d$"
weekdaystringoptionalA weekly schedule's day.
Validation rules
- Allowed values
["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]
dayOfMonthintegeroptionalA monthly schedule's day.
Validation rules
- Minimum
1- Maximum
28
timeZonestringrequiredThe IANA zone it keeps: Europe/London.
Validation rules
- Maximum length
64- Pattern
"^[A-Za-z][\\w+-]*(?:\\/[\\w+-]+)*$"
nextRunAtstring · date-timeoptionalWhen it runs next, while it is on.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
pausedAtstring · date-timeoptionalWhen it was paused, when Fin can tell.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
balanceobjectrequiredWhat each run spends from.
Show attributes
What each run spends from.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
maxValueLossBpsintegerrequiredThe most one run may lose.
Validation rules
- Minimum
0- Maximum
1000000
currentobjectrequiredAs it runs today.
Show attributes
As it runs today.
perRunanyOfrequiredWhat one run of an automation spends: an exact amount of an asset (1 USDC), or dollars of what it buys ($1 of NEAR). Fin works out every figure that follows from it either way.
Show attributes
What one run of an automation spends: an exact amount of an asset (1 USDC), or dollars of what it buys ($1 of NEAR). Fin works out every figure that follows from it either way.
anyOf · 2 variants
Variant 1 · object
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
Variant 2 · object
A dollar figure an automation spends.
usdstringrequiredDollars of what it buys: 1 reads $1 of NEAR.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
lastsRunsintegerrequiredHow many runs the balance pays for as it is.
Validation rules
- Minimum
0- Maximum
100000
amountobjectrequiredWhat each run spends.
Show attributes
What each run spends.
optionsarrayrequiredEvery value − and + can reach, lowest first, each with what follows from it.
Show attributes
Every value − and + can reach, lowest first, each with what follows from it.
Validation rules
- Minimum items
1- Maximum items
25
Array items · object
perRunanyOfrequiredWhat one run of an automation spends: an exact amount of an asset (1 USDC), or dollars of what it buys ($1 of NEAR). Fin works out every figure that follows from it either way.
Show attributes
What one run of an automation spends: an exact amount of an asset (1 USDC), or dollars of what it buys ($1 of NEAR). Fin works out every figure that follows from it either way.
anyOf · 2 variants
Variant 1 · object
An exact amount of one asset.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
Variant 2 · object
A dollar figure an automation spends.
usdstringrequiredDollars of what it buys: 1 reads $1 of NEAR.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
receiveEachobjectrequiredWhat each run gets at today's price.
Show attributes
What each run gets at today's price.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
lastsRunsintegerrequiredHow many runs the balance pays for at this amount.
Validation rules
- Minimum
0- Maximum
100000
lastsUntilstring · date-timerequiredWhen the balance runs out at this amount.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
suggestedintegerrequiredThe option the review opens on: Fin's choice.
Validation rules
- Minimum
0- Maximum
24
Variant 16 · kind: ask
Ask Fin: opens the page's chat with the question.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"ask"
questionstringrequiredThe question the chat opens with.
Validation rules
- Minimum length
1- Maximum length
300
Variant 17 · kind: open
A product Fin cannot run for you: its own form, filled in. Fin does not suggest it yet.
kindstringrequiredWhich review this is.
Validation rules
- Exact value
"open"
targetIdstringrequiredYour app's id for the form.
Validation rules
- Minimum length
1- Maximum length
64
amountobjectoptionalWhat Fin fills in.
Show attributes
What Fin fills in.
assetobjectrequiredAn asset a review names, as it draws and prints it.
Show attributes
An asset a review names, as it draws and prints it.
assetIdstringrequiredThe asset as Get balances and Prepare an order name it.
Validation rules
- Pattern
"^asset_[a-f0-9]{64}$"
symbolstringrequiredThe asset's symbol: NEAR, USDC, BTC, AAPL.
Validation rules
- Minimum length
1- Maximum length
32
decimalsintegerrequiredThe asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC.
Validation rules
- Minimum
0- Maximum
36
networkstringoptionalThe chain it sits on, for its badge: near, base; omitted for none.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
amountRawstringrequiredIn the asset's smallest unit, as a decimal integer string: 3000000 is 3 USDC.
Validation rules
- Maximum length
78- Pattern
"^(0|[1-9][0-9]*)$"
surfacesarrayrequiredThe pages it belongs on; home is always one.
Show attributes
The pages it belongs on; home is always one.
Validation rules
- Minimum items
1- Maximum items
8
Array items · string
A page of your app: home, orders, automations, swap, earn, or one asset's page as asset: and its assetId from Get balances.
Validation rules
- Pattern
"^(home|orders|automations|swap|earn|asset:asset_[a-f0-9]{64})$"
expiresAtstring · date-timerequiredWhen it stops showing, unless the account or the market moves it on sooner.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
400 The request could not be read as this operation expects.
The request could not be read as this operation expects.
invalid_input— the body or query failed validation;issuesnames each fieldinvalid_cursor— thecursoris not one this list minted
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
401 A credential is missing, invalid or expired.
A credential is missing, invalid or expired.
partner_key_required— noX-Api-Keyheader was sentpartner_key_invalid— theX-Api-Keyis unknown or revokedcredential_expired— the user token has expired; obtain a fresh one
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
403 The credentials are valid but may not do this.
The credentials are valid but may not do this.
subject_mismatch— the{userId}in the path is not the token's useraccount_disabled— an operator disabled the accountorigin_rejected— a browserOriginother than the configured web originpermission_required— the verified credential is not permitted to make this call
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
404 The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.
The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
409 The operation lost to the current state.
The operation lost to the current state.
suggestion_changed— the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions again
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
429 A limit refused the request; wait for `Retry-After` when it is sent.
A limit refused the request; wait for Retry-After when it is sent.
rate_limited— the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity— this partner's request quota across all keys and replicas is spent; honour Retry-After
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
500 A fault on our side; quote `requestId` when reporting it.
A fault on our side; quote requestId when reporting it.
internal— a fault on our side; quoterequestIdwhen reporting it
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
503 The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); `retryable` says whether to try again.
The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); retryable says whether to try again.
internal— a fault on our side; quoterequestIdwhen reporting it
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
Complete OpenAPI definition
The exact operation and all referenced components, including recursive schemas.
{
"operation": {
"operationId": "suggestions.review",
"summary": "Get a suggestion's review",
"tags": [
"suggestions"
],
"description": "Checks one suggestion again against the account as it is now and returns it with fresh review terms. Call it when the user opens a suggestion's review, then draw the review from `review` and confirm the move through the routes that make it. When the suggestion no longer holds (the account or the price moved, the user set it aside, or it cannot be made where the user is now), it answers `409 suggestion_changed`: say it changed since Fin suggested it, and read the page's suggestions again.",
"parameters": [
{
"schema": {
"type": "string",
"maxLength": 64,
"pattern": "^[A-Za-z][\\w+-]*(?:\\/[\\w+-]+)*$"
},
"in": "query",
"name": "timeZone",
"required": false,
"description": "The user's time zone as an IANA name, such as `America/New_York`: dates in titles, reasons and new schedules read in it. Without it they read in UTC, and Fin suggests no new schedule."
},
{
"schema": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"in": "query",
"name": "country",
"required": false,
"description": "The country the user is reading from, as an uppercase ISO 3166-1 alpha-2 code your server resolved, never the browser's word. A move on a tokenized stock shows only where stocks are available; without it, none shows."
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
},
"in": "query",
"name": "perpsAllowed",
"required": false,
"description": "`true` when your app lets this user fund perpetuals where they are now; without it, no perps move shows."
},
{
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
},
"in": "path",
"name": "userId",
"required": true,
"description": "Your id for the user: the `userId` you sent to Create a user. It must be the session's user."
},
{
"schema": {
"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)$"
},
"in": "path",
"name": "suggestionId",
"required": true,
"description": "The suggestion's `id`, from List suggestions."
}
],
"security": [
{
"apiKey": [],
"userToken": []
}
],
"responses": {
"200": {
"description": "The suggestion, checked again, with fresh terms.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuggestedMove"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidInput"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"description": "The operation lost to the current state.\n\n- `suggestion_changed` — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions again",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"500": {
"$ref": "#/components/responses/Internal"
},
"503": {
"$ref": "#/components/responses/Unavailable"
}
}
},
"components": {
"schemas": {
"SuggestedMove": {
"type": "object",
"properties": {
"id": {
"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)$",
"description": "The suggestion's id. The same move in a later read keeps it."
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 120,
"description": "The move, verb first, with its exact terms: `Move your NEAR buy to $4.80`."
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 280,
"description": "Why, in one sentence; Fin filled in every figure from the account."
},
"review": {
"$ref": "#/components/schemas/ReviewTerms"
},
"surfaces": {
"minItems": 1,
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"pattern": "^(home|orders|automations|swap|earn|asset:asset_[a-f0-9]{64})$",
"description": "A page of your app: `home`, `orders`, `automations`, `swap`, `earn`, or one asset's page as `asset:` and its `assetId` from Get balances."
},
"description": "The pages it belongs on; `home` is always one."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When it stops showing, unless the account or the market moves it on sooner."
}
},
"required": [
"id",
"title",
"reason",
"review",
"surfaces",
"expiresAt"
],
"description": "One move Fin suggests on the user's own money, and the exact terms its review draws. Nothing moves until the user reviews and confirms it."
},
"ReviewTerms": {
"oneOf": [
{
"$ref": "#/components/schemas/SwapReview"
},
{
"$ref": "#/components/schemas/LimitOrderReview"
},
{
"$ref": "#/components/schemas/OrderMoveReview"
},
{
"$ref": "#/components/schemas/OrderCancelReview"
},
{
"$ref": "#/components/schemas/RecurringBuyReview"
},
{
"$ref": "#/components/schemas/PriceRuleReview"
},
{
"$ref": "#/components/schemas/SummaryReview"
},
{
"$ref": "#/components/schemas/DepositReview"
},
{
"$ref": "#/components/schemas/WithdrawReview"
},
{
"$ref": "#/components/schemas/SendReview"
},
{
"$ref": "#/components/schemas/PerpsFundReview"
},
{
"$ref": "#/components/schemas/AutomationPauseReview"
},
{
"$ref": "#/components/schemas/AutomationResumeReview"
},
{
"$ref": "#/components/schemas/AutomationEndReview"
},
{
"$ref": "#/components/schemas/AutomationChangeReview"
},
{
"$ref": "#/components/schemas/AskReview"
},
{
"$ref": "#/components/schemas/OpenReview"
}
],
"description": "The exact terms a suggestion's review draws, keyed by `kind`: every id and asset the move needs, and the one figure − and + adjust."
},
"SwapReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "swap",
"description": "Which review this is."
},
"balance": {
"description": "What you hold of the asset you pay with.",
"$ref": "#/components/schemas/AssetAmount"
},
"buy": {
"$ref": "#/components/schemas/ReviewAsset"
},
"buyPriceUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "One unit of the bought asset now."
},
"maxValueLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 1000000,
"description": "The most the swap may lose, fees and price included."
},
"etaSeconds": {
"description": "Fin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"amount": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"pay": {
"description": "What Get a swap quote sells, exactly.",
"$ref": "#/components/schemas/AssetAmount"
},
"receive": {
"description": "What it gets at today's price.",
"$ref": "#/components/schemas/AssetAmount"
},
"receiveAtLeast": {
"description": "The least it gets within the loss limit.",
"$ref": "#/components/schemas/AssetAmount"
}
},
"required": [
"pay",
"receive",
"receiveAtLeast"
]
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "How much to swap."
}
},
"required": [
"kind",
"balance",
"buy",
"buyPriceUsd",
"maxValueLossBps",
"amount"
],
"description": "Swap now: what you pay against what you get."
},
"AssetAmount": {
"type": "object",
"properties": {
"asset": {
"$ref": "#/components/schemas/ReviewAsset"
},
"amountRaw": {
"type": "string",
"maxLength": 78,
"pattern": "^(0|[1-9][0-9]*)$",
"description": "In the asset's smallest unit, as a decimal integer string: `3000000` is 3 USDC."
}
},
"required": [
"asset",
"amountRaw"
],
"description": "An exact amount of one asset."
},
"ReviewAsset": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"pattern": "^asset_[a-f0-9]{64}$",
"description": "The asset as Get balances and Prepare an order name it."
},
"symbol": {
"type": "string",
"minLength": 1,
"maxLength": 32,
"description": "The asset's symbol: `NEAR`, `USDC`, `BTC`, `AAPL`."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 36,
"description": "The asset's own scale: 24 for NEAR, 6 for USDC, 8 for BTC."
},
"network": {
"description": "The chain it sits on, for its badge: `near`, `base`; omitted for none.",
"type": "string",
"pattern": "^[a-z][a-z0-9-]{0,63}$"
}
},
"required": [
"assetId",
"symbol",
"decimals"
],
"description": "An asset a review names, as it draws and prints it."
},
"LimitOrderReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "limit_order",
"description": "Which review this is."
},
"side": {
"type": "string",
"enum": [
"buy",
"sell"
],
"description": "Whether it buys or sells the asset."
},
"asset": {
"description": "The asset the order buys or sells.",
"$ref": "#/components/schemas/ReviewAsset"
},
"marketPriceUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "One unit of the asset now."
},
"spend": {
"description": "What a buy spends or a sell sells.",
"$ref": "#/components/schemas/AssetAmount"
},
"holding": {
"description": "A sell: what you hold of the asset.",
"$ref": "#/components/schemas/AssetAmount"
},
"expiresInHours": {
"type": "integer",
"minimum": 1,
"maximum": 720,
"description": "How long the order rests."
},
"price": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderPriceOption"
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "Your price."
}
},
"required": [
"kind",
"side",
"asset",
"marketPriceUsd",
"spend",
"expiresInHours",
"price"
],
"description": "A limit buy or sell: your price against the market."
},
"OrderPriceOption": {
"type": "object",
"properties": {
"limitPriceUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "Your price in dollars per one unit of the asset."
},
"toGoBps": {
"type": "integer",
"minimum": 0,
"maximum": 1000000,
"description": "How far the market must move to fill, from today; 0 fills at once."
},
"receive": {
"description": "What the order gets at this price.",
"$ref": "#/components/schemas/AssetAmount"
},
"order": {
"description": "Prepare an order's request for this price, exactly.",
"$ref": "#/components/schemas/OrderRequest"
}
},
"required": [
"limitPriceUsd",
"toGoBps",
"receive",
"order"
],
"description": "A limit order's price, with what depends on it."
},
"OrderRequest": {
"type": "object",
"properties": {
"sellAssetId": {
"type": "string",
"pattern": "^asset_[a-f0-9]{64}$",
"description": "The asset to sell from the agent wallet: an `assetId` from Get balances."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact amount to sell, in the sold asset's smallest unit. It leaves the agent wallet when the order is placed."
},
"buyAssetId": {
"type": "string",
"pattern": "^asset_[a-f0-9]{64}$",
"description": "The asset to buy: an `id` from List supported assets. What the order buys comes back to the agent wallet."
},
"limitPrice": {
"type": "string",
"maxLength": 80,
"pattern": "^(0|[1-9]\\d{0,38})(\\.\\d{1,38})?$",
"description": "The least the order sells at, as bought-asset units per ONE sold unit, written as a plain decimal: \"5\" means at least 5 of the bought asset for each one sold. Never scale it by decimals."
},
"expiresInHours": {
"type": "integer",
"minimum": 1,
"maximum": 720,
"description": "How long the order rests before it expires, in whole hours from 1 to 720 (30 days)."
},
"context": {
"type": "object",
"properties": {
"country": {
"description": "The country the user is making this request from, as an uppercase ISO 3166-1 alpha-2 code such as `GB`, resolved by your server from the request (your edge's IP geolocation), never taken from the browser. A tokenized stock is traded only when this reports a country where it is available.",
"type": "string",
"pattern": "^[A-Z]{2}$"
}
},
"description": "What your app knows about the user as they make this request. It applies to this request only, so send it with every request that may trade a tokenized stock."
}
},
"required": [
"sellAssetId",
"amountRaw",
"buyAssetId",
"limitPrice",
"expiresInHours"
],
"description": "What to sell, how much, what to buy, the least it sells at and how long it rests; preparing fills in the least the whole order receives. An order of a tokenized stock also needs `context.country`."
},
"OrderMoveReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "order_move",
"description": "Which review this is."
},
"orderId": {
"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)$",
"description": "The order's `id`, as List orders names it."
},
"side": {
"type": "string",
"enum": [
"buy",
"sell"
],
"description": "Whether it buys or sells the asset."
},
"asset": {
"$ref": "#/components/schemas/ReviewAsset"
},
"marketPriceUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "One unit of the asset now."
},
"spend": {
"description": "What the order spends or sells; the move keeps it.",
"$ref": "#/components/schemas/AssetAmount"
},
"current": {
"type": "object",
"properties": {
"limitPriceUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "Its price now."
},
"receive": {
"description": "What it gets at that price.",
"$ref": "#/components/schemas/AssetAmount"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When it expires as it rests now."
}
},
"required": [
"limitPriceUsd",
"receive",
"expiresAt"
],
"description": "The order as it rests now."
},
"expiresInHours": {
"type": "integer",
"minimum": 1,
"maximum": 720,
"description": "How long the new order rests."
},
"price": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderPriceOption"
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "The new price. An option at the current price renews the order as it is."
}
},
"required": [
"kind",
"orderId",
"side",
"asset",
"marketPriceUsd",
"spend",
"current",
"expiresInHours",
"price"
],
"description": "Move an order: cancel it and place the same order at a new price, or at its own price to renew it."
},
"OrderCancelReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "order_cancel",
"description": "Which review this is."
},
"orderId": {
"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)$",
"description": "The order's `id`, as List orders names it."
},
"side": {
"type": "string",
"enum": [
"buy",
"sell"
],
"description": "Whether it buys or sells the asset."
},
"asset": {
"$ref": "#/components/schemas/ReviewAsset"
},
"spend": {
"description": "What the order spends or sells.",
"$ref": "#/components/schemas/AssetAmount"
},
"limitPriceUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "Its price."
},
"placedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When it was placed."
},
"filledBps": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "How much has filled: 0 is nothing."
},
"returns": {
"description": "What comes back to the account.",
"$ref": "#/components/schemas/AssetAmount"
},
"filled": {
"description": "What has filled and stays; omitted for none.",
"$ref": "#/components/schemas/AssetAmount"
},
"etaSeconds": {
"description": "Fin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.",
"type": "integer",
"minimum": 1,
"maximum": 86400
}
},
"required": [
"kind",
"orderId",
"side",
"asset",
"spend",
"limitPriceUsd",
"placedAt",
"filledBps",
"returns"
],
"description": "Cancel an order: what it was, and what comes back."
},
"RecurringBuyReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "recurring_buy",
"description": "Which review this is."
},
"asset": {
"description": "What each run buys.",
"$ref": "#/components/schemas/ReviewAsset"
},
"balance": {
"description": "What each run spends from, and what you hold of it.",
"$ref": "#/components/schemas/AssetAmount"
},
"schedule": {
"$ref": "#/components/schemas/ReviewSchedule"
},
"upcoming": {
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "An instant in RFC 3339, such as `2026-11-07T09:00:00Z`."
},
"description": "The next runs, first first."
},
"maxRuns": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "How many buys it makes at most."
},
"endsAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When it ends."
},
"maxValueLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 1000000,
"description": "The most one buy may lose."
},
"askEachTime": {
"type": "boolean",
"description": "Fin's pick for asking before each buy."
},
"amount": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"perRun": {
"$ref": "#/components/schemas/RunSpend"
},
"receiveEach": {
"description": "What each buy gets at today's price.",
"$ref": "#/components/schemas/AssetAmount"
},
"runsCovered": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "How many of `upcoming` your balance pays for."
}
},
"required": [
"perRun",
"receiveEach",
"runsCovered"
]
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "What each run spends."
}
},
"required": [
"kind",
"asset",
"balance",
"schedule",
"upcoming",
"maxRuns",
"endsAt",
"maxValueLossBps",
"askEachTime",
"amount"
],
"description": "A recurring buy: the runs your money covers."
},
"ReviewSchedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly",
"monthly"
],
"description": "How often it runs."
},
"time": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"description": "Local time of day, 24-hour: `09:00`."
},
"weekday": {
"description": "A weekly schedule's day.",
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"dayOfMonth": {
"description": "A monthly schedule's day.",
"type": "integer",
"minimum": 1,
"maximum": 28
},
"timeZone": {
"type": "string",
"maxLength": 64,
"pattern": "^[A-Za-z][\\w+-]*(?:\\/[\\w+-]+)*$",
"description": "The IANA zone it keeps: `Europe/London`."
}
},
"required": [
"cadence",
"time",
"timeZone"
],
"description": "When a schedule runs, in the zone it keeps."
},
"RunSpend": {
"anyOf": [
{
"$ref": "#/components/schemas/AssetAmount"
},
{
"$ref": "#/components/schemas/DollarAmount"
}
],
"description": "What one run of an automation spends: an exact amount of an asset (`1 USDC`), or dollars of what it buys (`$1 of NEAR`). Fin works out every figure that follows from it either way."
},
"DollarAmount": {
"type": "object",
"properties": {
"usd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "Dollars of what it buys: `1` reads `$1 of NEAR`."
}
},
"required": [
"usd"
],
"description": "A dollar figure an automation spends."
},
"PriceRuleReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "price_rule",
"description": "Which review this is."
},
"side": {
"type": "string",
"enum": [
"buy",
"sell"
],
"description": "Whether it buys or sells the asset."
},
"direction": {
"type": "string",
"enum": [
"below",
"above"
],
"description": "Whether it runs once the price drops below its line or rises above it."
},
"asset": {
"description": "The asset it watches and trades.",
"$ref": "#/components/schemas/ReviewAsset"
},
"marketPriceUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "One unit of the asset now."
},
"spend": {
"description": "What a buy spends or a sell sells.",
"$ref": "#/components/schemas/AssetAmount"
},
"holding": {
"description": "A sell: what you hold of the asset.",
"$ref": "#/components/schemas/AssetAmount"
},
"history": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "An instant in RFC 3339, such as `2026-11-07T09:00:00Z`."
},
"to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "An instant in RFC 3339, such as `2026-11-07T09:00:00Z`."
},
"closesUsd": {
"maxItems": 400,
"type": "array",
"items": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "US dollars as exact decimal text, such as `4.80` or `82732`; never a float."
},
"description": "Daily closes, oldest first."
}
},
"required": [
"from",
"to",
"closesUsd"
],
"description": "The chart's line."
},
"maxRuns": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "How many times it runs: 1 runs once."
},
"checkEveryMinutes": {
"type": "integer",
"minimum": 1,
"maximum": 1440,
"description": "How often it checks the price."
},
"endsAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When it ends."
},
"maxValueLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 1000000,
"description": "The most it may lose when it runs."
},
"threshold": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"thresholdUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "The price that starts it."
},
"distanceBps": {
"type": "integer",
"minimum": 0,
"maximum": 1000000,
"description": "How far that is from today's price."
},
"receive": {
"description": "A sell: the least it receives there; a buy: what it buys there.",
"$ref": "#/components/schemas/AssetAmount"
}
},
"required": [
"thresholdUsd",
"distanceBps",
"receive"
]
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "The price line."
}
},
"required": [
"kind",
"side",
"direction",
"asset",
"marketPriceUsd",
"spend",
"history",
"maxRuns",
"checkEveryMinutes",
"endsAt",
"maxValueLossBps",
"threshold"
],
"description": "Buy or sell once a price crosses a line."
},
"SummaryReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "summary",
"description": "Which review this is."
},
"schedule": {
"$ref": "#/components/schemas/ReviewSchedule"
},
"preview": {
"type": "string",
"minLength": 1,
"maxLength": 600,
"description": "A sample of the first summary, written by Fin from the account: plain text."
},
"thread": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The page whose thread it writes in: `home`."
},
"time": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"time": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"description": "Local time of day, 24-hour."
},
"firstAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When the first one comes."
}
},
"required": [
"time",
"firstAt"
]
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "The time of day it comes."
}
},
"required": [
"kind",
"schedule",
"preview",
"thread",
"time"
],
"description": "A summary Fin writes on a schedule; no money moves."
},
"DepositReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "deposit",
"description": "Which review this is."
},
"asset": {
"description": "What is sent and on which chain.",
"$ref": "#/components/schemas/ReviewAsset"
},
"room": {
"description": "The deposit limit, what the account holds against it, and what is left; omitted when no limit applies.",
"type": "object",
"properties": {
"limitUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "US dollars as exact decimal text, such as `4.80` or `82732`; never a float."
},
"usedUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "US dollars as exact decimal text, such as `4.80` or `82732`; never a float."
},
"leftUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "US dollars as exact decimal text, such as `4.80` or `82732`; never a float."
}
},
"required": [
"limitUsd",
"usedUsd",
"leftUsd"
]
},
"networkFeeUsd": {
"description": "Fin's estimate of the sending chain's fee; omitted without one.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
},
"etaSeconds": {
"description": "Fin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"amount": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"deposit": {
"$ref": "#/components/schemas/AssetAmount"
},
"usd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "Its worth now."
},
"leftAfterUsd": {
"description": "What is left of the room after it; omitted when no limit applies.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$"
}
},
"required": [
"deposit",
"usd"
]
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "How much to deposit."
}
},
"required": [
"kind",
"asset",
"amount"
],
"description": "Add money from the connected wallet."
},
"WithdrawReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "withdraw",
"description": "Which review this is."
},
"balance": {
"description": "What you hold of the asset.",
"$ref": "#/components/schemas/AssetAmount"
},
"destination": {
"description": "Your own wallet, the only place a withdrawal goes, when Fin knows its address; otherwise your app's own connected wallet.",
"type": "object",
"properties": {
"address": {
"type": "string",
"pattern": "^[\\x21-\\x7e]{1,256}$",
"description": "The wallet's address on its network."
},
"network": {
"type": "string",
"pattern": "^[a-z][a-z0-9-]{0,63}$",
"description": "The network, as List supported assets names it."
}
},
"required": [
"address",
"network"
]
},
"etaSeconds": {
"description": "Fin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"amount": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"withdraw": {
"$ref": "#/components/schemas/AssetAmount"
},
"fee": {
"description": "The fee, from a real quote; omitted without one.",
"$ref": "#/components/schemas/AssetAmount"
},
"arrivesAtLeast": {
"description": "The least that arrives, from a real quote; omitted without one.",
"$ref": "#/components/schemas/AssetAmount"
},
"stays": {
"description": "What stays in the account.",
"$ref": "#/components/schemas/AssetAmount"
}
},
"required": [
"withdraw",
"stays"
]
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "How much to withdraw."
}
},
"required": [
"kind",
"balance",
"amount"
],
"description": "Move money back to your own wallet."
},
"SendReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "send",
"description": "Which review this is."
},
"contactId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Your app's contact."
},
"purpose": {
"description": "What it is for, in Fin's words.",
"type": "string",
"maxLength": 80
},
"balance": {
"$ref": "#/components/schemas/AssetAmount"
},
"etaSeconds": {
"description": "Fin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"amount": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"send": {
"$ref": "#/components/schemas/AssetAmount"
},
"fee": {
"$ref": "#/components/schemas/AssetAmount"
},
"arrivesAtLeast": {
"$ref": "#/components/schemas/AssetAmount"
}
},
"required": [
"send"
]
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "How much to send."
}
},
"required": [
"kind",
"contactId",
"balance",
"amount"
],
"description": "Send to a saved contact. Fin does not suggest it yet."
},
"PerpsFundReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "perps_fund",
"description": "Which review this is."
},
"balance": {
"$ref": "#/components/schemas/AssetAmount"
},
"etaSeconds": {
"description": "Fin's estimate of how long it takes, in seconds, from a real quote; omitted without one, when the review says its usual time.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"amount": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"move": {
"$ref": "#/components/schemas/AssetAmount"
}
},
"required": [
"move"
]
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "How much to move."
}
},
"required": [
"kind",
"balance",
"amount"
],
"description": "Move margin to the perps account."
},
"AutomationPauseReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "automation_pause",
"description": "Which review this is."
},
"automation": {
"$ref": "#/components/schemas/ReviewAutomation"
},
"upcoming": {
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "An instant in RFC 3339, such as `2026-11-07T09:00:00Z`."
},
"description": "The next runs it would make, all skipped while paused."
},
"coverage": {
"$ref": "#/components/schemas/ReviewCoverage"
}
},
"required": [
"kind",
"automation",
"upcoming",
"coverage"
],
"description": "Pause an automation."
},
"ReviewAutomation": {
"type": "object",
"properties": {
"automationId": {
"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)$",
"description": "The automation's id."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120,
"description": "The automation's own name, as its owner wrote it."
},
"trigger": {
"type": "string",
"enum": [
"schedule",
"price-drop",
"price-rise",
"event"
],
"description": "What starts its runs. An `event` one runs when something happens and has no price or time to draw."
},
"asset": {
"description": "The asset it buys or sells.",
"$ref": "#/components/schemas/ReviewAsset"
},
"schedule": {
"description": "A scheduled one's schedule.",
"$ref": "#/components/schemas/ReviewSchedule"
},
"nextRunAt": {
"description": "When it runs next, while it is on.",
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"pausedAt": {
"description": "When it was paused, when Fin can tell.",
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"automationId",
"name",
"trigger"
],
"description": "An automation a review changes."
},
"ReviewCoverage": {
"type": "object",
"properties": {
"by": {
"description": "The money that pays: the spendable balance.",
"$ref": "#/components/schemas/AssetAmount"
},
"byDeposit": {
"type": "boolean",
"description": "True when that balance is there because a deposit landed since the last run."
},
"runsCovered": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "How many of the coming runs it pays for; 0 pays for none."
},
"runsLeft": {
"description": "Runs left before the automation ends.",
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
"required": [
"by",
"byDeposit",
"runsCovered"
],
"description": "What pays for a schedule's coming runs."
},
"AutomationResumeReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "automation_resume",
"description": "Which review this is."
},
"automation": {
"$ref": "#/components/schemas/ReviewAutomation"
},
"upcoming": {
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "An instant in RFC 3339, such as `2026-11-07T09:00:00Z`."
},
"description": "The next runs, first first."
},
"coverage": {
"$ref": "#/components/schemas/ReviewCoverage"
},
"endsAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When its approval ends."
},
"runsUsed": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "Runs it has made."
},
"maxRuns": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "Runs its approval allows in all."
}
},
"required": [
"kind",
"automation",
"upcoming",
"coverage",
"endsAt",
"runsUsed",
"maxRuns"
],
"description": "Resume a paused automation under the approval it already has."
},
"AutomationEndReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "automation_end",
"description": "Which review this is."
},
"automation": {
"$ref": "#/components/schemas/ReviewAutomation"
},
"runs": {
"type": "object",
"properties": {
"done": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "Runs it made."
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "Runs its approval allowed."
}
},
"required": [
"done",
"total"
],
"description": "Runs made of the runs approved."
},
"stillCovered": {
"description": "Another automation of yours still watching the asset.",
"type": "object",
"properties": {
"side": {
"type": "string",
"enum": [
"buy",
"sell"
],
"description": "Whether it buys or sells the asset."
},
"direction": {
"type": "string",
"enum": [
"below",
"above"
],
"description": "Whether it runs below its line or above it."
},
"thresholdUsd": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$",
"description": "Its line."
}
},
"required": [
"side",
"direction",
"thresholdUsd"
]
}
},
"required": [
"kind",
"automation",
"runs"
],
"description": "End an automation: its history stays, its runs stop."
},
"AutomationChangeReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "automation_change",
"description": "Which review this is."
},
"automation": {
"$ref": "#/components/schemas/ReviewAutomation"
},
"balance": {
"description": "What each run spends from.",
"$ref": "#/components/schemas/AssetAmount"
},
"maxValueLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 1000000,
"description": "The most one run may lose."
},
"current": {
"type": "object",
"properties": {
"perRun": {
"$ref": "#/components/schemas/RunSpend"
},
"lastsRuns": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "How many runs the balance pays for as it is."
}
},
"required": [
"perRun",
"lastsRuns"
],
"description": "As it runs today."
},
"amount": {
"type": "object",
"properties": {
"options": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"perRun": {
"$ref": "#/components/schemas/RunSpend"
},
"receiveEach": {
"description": "What each run gets at today's price.",
"$ref": "#/components/schemas/AssetAmount"
},
"lastsRuns": {
"type": "integer",
"minimum": 0,
"maximum": 100000,
"description": "How many runs the balance pays for at this amount."
},
"lastsUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When the balance runs out at this amount."
}
},
"required": [
"perRun",
"receiveEach",
"lastsRuns",
"lastsUntil"
]
},
"description": "Every value − and + can reach, lowest first, each with what follows from it."
},
"suggested": {
"type": "integer",
"minimum": 0,
"maximum": 24,
"description": "The option the review opens on: Fin's choice."
}
},
"required": [
"options",
"suggested"
],
"description": "What each run spends."
}
},
"required": [
"kind",
"automation",
"balance",
"maxValueLossBps",
"current",
"amount"
],
"description": "Change what each run of an automation spends."
},
"AskReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "ask",
"description": "Which review this is."
},
"question": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"description": "The question the chat opens with."
}
},
"required": [
"kind",
"question"
],
"description": "Ask Fin: opens the page's chat with the question."
},
"OpenReview": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "open",
"description": "Which review this is."
},
"targetId": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Your app's id for the form."
},
"amount": {
"description": "What Fin fills in.",
"$ref": "#/components/schemas/AssetAmount"
}
},
"required": [
"kind",
"targetId"
],
"description": "A product Fin cannot run for you: its own form, filled in. Fin does not suggest it yet."
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The kind of problem as a URN, `urn:fin:error:<kind>`; stable, compare against it"
},
"title": {
"type": "string",
"description": "The kind's human title, for logs; never parse it"
},
"status": {
"type": "integer",
"minimum": 400,
"maximum": 599,
"description": "The HTTP status, repeated in the body"
},
"reason": {
"description": "The machine-readable why. One of:\n\n- `run_active` (409) — a run already holds this conversation\n- `budget_exhausted` (429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze it\n- `approval_not_pending` (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation\n- `execution_capacity` (429) — no capacity is free to run this right now; honour `Retry-After`\n- `execution_unavailable` (503) — the service that runs the agent could not take the work; `retryable` says whether to try again\n- `stop_pending` (409) — a stop is already in progress and its cleanup is not yet confirmed\n- `automation_changed` (409) — the automation changed while this request was handled; read it again and retry\n- `automation_held` (409) — an operator holds the automation; it fires again when released\n- `automation_invalid` (409) — the automation's definition cannot run as written\n- `automation_paused` (409) — the automation is paused; resume it first\n- `automation_has_no_webhook` (409) — the automation does not run on incoming events, so it has no webhook\n- `automation_limit` (409) — the user already has as many automations as the deployment allows\n- `profile_unknown_tool` (400) — `profile.tools` names a tool this deployment does not have\n- `deployment_paused` (503) — an operator paused this kind of work for the deployment; try again later\n- `run_not_active` (409) — the run named in the path is not the conversation's live run\n- `withdrawal_changed` (409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amount\n- `swap_changed` (409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quote\n- `order_changed` (409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it again\n- `prediction_order_changed` (409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it again\n- `solana_trade_changed` (409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it again\n- `trade_not_recoverable` (409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be used\n- `order_not_cancelable` (409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it stands\n- `grid_not_active` (409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it stands\n- `grid_not_paused` (409) — the grid is not paused, so there is nothing to resume. Read the grid for where it stands\n- `suggestion_changed` (409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions again\n- `request_key_conflict` (409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new request\n- `question_not_pending` (409) — the questionnaire has already been answered, closed, or is not awaiting this submission\n- `flag_changed` (409) — the flag's targeting changed since you read it; read it again and retry\n- `group_changed` (409) — the group changed or was deleted since you read it; read it again and retry\n- `group_in_use` (409) — a flag's rules still name this group; take it out of those rules first\n- `group_name_taken` (409) — another group already has this name\n- `agent_wallet_required` (409) — create the agent wallet before opening a perps, prediction-market or Solana account\n- `wallet_account_unsupported` (409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session instead\n- `conversation_deleted` (410) — the conversation was deleted; its history stays readable\n- `automation_deleted` (410) — the automation was deleted\n- `grid_ended` (410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chat\n- `credential_expired` (401) — the user token has expired; obtain a fresh one\n- `account_disabled` (403) — an operator disabled the account\n- `perps_disabled` (403) — perps is not enabled for this user\n- `prediction_disabled` (403) — prediction-market trading is not enabled for this user\n- `solana_disabled` (403) — Solana trading is not enabled for this user\n- `no_account` (404) — the user has not opened the account this call reads; open it first\n- `not_available_in_region` (403) — perps funding is unavailable in the user's region for this request; withdrawals remain available\n- `steering_disabled` (403) — steering a working run is not turned on for this user; send the message with Start a run once the run ends\n- `baskets_disabled` (403) — idea baskets are not turned on for this user; hide the Ideas pages and their baskets\n- `basket_buying` (409) — the basket is still buying, so it cannot be deleted yet; try again once its result is in\n- `basket_awaiting_approval` (409) — an approval to buy this basket is still open; decline it in the chat, then delete the basket\n- `basket_step_not_failed` (409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket again\n- `basket_step_linked` (409) — another order is already linked to this step; a link is permanent, so read the basket again\n- `basket_order_not_linkable` (400) — the order cannot stand in for this step: it is not one of the step's `failures[].linkable` orders, or another basket step already holds it\n- `voice_disabled` (403) — voice input is not turned on for this user; let them type instead\n- `voice_unavailable` (503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type instead\n- `provider_unavailable` (503) — an external provider the call depends on did not answer\n- `quote_refused` (400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another network\n- `invalid_input` (400) — the body or query failed validation; `issues` names each field\n- `internal` (500) — a fault on our side; quote `requestId` when reporting it\n- `partner_key_required` (401) — no `X-Api-Key` header was sent\n- `partner_key_invalid` (401) — the `X-Api-Key` is unknown or revoked\n- `subject_mismatch` (403) — the `{userId}` in the path is not the token's user\n- `origin_rejected` (403) — a browser `Origin` other than the configured web origin\n- `permission_required` (403) — the verified credential is not permitted to make this call\n- `signature_required` (403) — creating the agent wallet needs the user's signature: send the user's signature of `creation.message` from Get the agent wallet as `authorization`\n- `asset_not_withdrawable` (403) — tokenized stocks cannot be withdrawn; sell them first\n- `asset_not_swappable` (403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with no `context.country`, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user's `earn` flag is off\n- `asset_not_tradable` (403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with no `context.country`, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user's `earn` flag is off\n- `solana_token_not_tradable` (403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landing\n- `limit_orders_disabled` (403) — limit orders are not enabled for this user\n- `grid_trading_disabled` (403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gated\n- `deposit_limit_exceeded` (429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. Read `depositLimit.availableCents` from Get balances for how much fits now, and deposit no more than that\n- `policy_change_throttled` (429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again once `Retry-After` has passed\n- `agent_slippage_exceeded` (403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (`max_slippage_bps`): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss bound\n- `agent_api_orders_unavailable` (403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signed\n- `destination_not_allowed` (403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signed\n- `rate_limited` (429) — the per-key or per-user limit is spent; honour `Retry-After`\n- `partner_request_capacity` (429) — this partner's request quota across all keys and replicas is spent; honour Retry-After\n- `partner_run_capacity` (429) — this partner's active run quota is full; honour Retry-After and reuse the same request identity\n- `stream_capacity` (429) — the partner, user or replica has no free stream capacity; honour `Retry-After`\n- `invalid_cursor` (400) — the `cursor` is not one this list minted\n- `invalid_question_answer` (400) — the questionnaire answer does not match its questions or allowed choices\n- `question_closed` (410) — the questionnaire expired or was cancelled\n- `unknown_target` (400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule names\n- `scope_invalid` (400) — a subject in the scope is not a subject id, or appears twice\n- `subject_unsupported` (404) — a subject in the scope is not one market briefs cover; list them with List market subjects\n- `brief_not_found` (404) — no market brief job with this id was created with your partner key\n- `briefs_busy` (429) — your market briefs are at their limit of briefs generating at once; retry after `Retry-After`\n- `market_briefs_disabled` (403) — market briefs are not turned on for your partner key\n- `story_not_found` (404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read",
"type": "string",
"enum": [
"run_active",
"budget_exhausted",
"approval_not_pending",
"execution_capacity",
"execution_unavailable",
"stop_pending",
"automation_changed",
"automation_held",
"automation_invalid",
"automation_paused",
"automation_has_no_webhook",
"automation_limit",
"profile_unknown_tool",
"deployment_paused",
"run_not_active",
"withdrawal_changed",
"swap_changed",
"order_changed",
"prediction_order_changed",
"solana_trade_changed",
"trade_not_recoverable",
"order_not_cancelable",
"grid_not_active",
"grid_not_paused",
"suggestion_changed",
"request_key_conflict",
"question_not_pending",
"flag_changed",
"group_changed",
"group_in_use",
"group_name_taken",
"agent_wallet_required",
"wallet_account_unsupported",
"conversation_deleted",
"automation_deleted",
"grid_ended",
"credential_expired",
"account_disabled",
"perps_disabled",
"prediction_disabled",
"solana_disabled",
"no_account",
"not_available_in_region",
"steering_disabled",
"baskets_disabled",
"basket_buying",
"basket_awaiting_approval",
"basket_step_not_failed",
"basket_step_linked",
"basket_order_not_linkable",
"voice_disabled",
"voice_unavailable",
"provider_unavailable",
"quote_refused",
"invalid_input",
"internal",
"partner_key_required",
"partner_key_invalid",
"subject_mismatch",
"origin_rejected",
"permission_required",
"signature_required",
"asset_not_withdrawable",
"asset_not_swappable",
"asset_not_tradable",
"solana_token_not_tradable",
"limit_orders_disabled",
"grid_trading_disabled",
"deposit_limit_exceeded",
"policy_change_throttled",
"agent_slippage_exceeded",
"agent_api_orders_unavailable",
"destination_not_allowed",
"rate_limited",
"partner_request_capacity",
"partner_run_capacity",
"stream_capacity",
"invalid_cursor",
"invalid_question_answer",
"question_closed",
"unknown_target",
"scope_invalid",
"subject_unsupported",
"brief_not_found",
"briefs_busy",
"market_briefs_disabled",
"story_not_found"
]
},
"requestId": {
"type": "string",
"description": "The id Fin used for this request; quote it when reporting a problem"
},
"retryable": {
"type": "boolean",
"description": "Whether repeating the same request later can succeed without changing it"
},
"detail": {
"description": "Only on `invalid_input`: which part of the request failed validation",
"type": "string"
},
"issues": {
"description": "Only on `invalid_input`: one entry per failing field",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The JSON pointer of the failing field; empty for the root object"
},
"message": {
"type": "string",
"description": "Why the field failed"
}
},
"required": [
"path",
"message"
]
}
}
},
"required": [
"type",
"title",
"status",
"requestId",
"retryable"
],
"description": "RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack."
}
},
"responses": {
"InvalidInput": {
"description": "The request could not be read as this operation expects.\n\n- `invalid_input` — the body or query failed validation; `issues` names each field\n- `invalid_cursor` — the `cursor` is not one this list minted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Unauthorized": {
"description": "A credential is missing, invalid or expired.\n\n- `partner_key_required` — no `X-Api-Key` header was sent\n- `partner_key_invalid` — the `X-Api-Key` is unknown or revoked\n- `credential_expired` — the user token has expired; obtain a fresh one",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Forbidden": {
"description": "The credentials are valid but may not do this.\n\n- `subject_mismatch` — the `{userId}` in the path is not the token's user\n- `account_disabled` — an operator disabled the account\n- `origin_rejected` — a browser `Origin` other than the configured web origin\n- `permission_required` — the verified credential is not permitted to make this call",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"NotFound": {
"description": "The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"TooManyRequests": {
"description": "A limit refused the request; wait for `Retry-After` when it is sent.\n\n- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`\n- `partner_request_capacity` — this partner's request quota across all keys and replicas is spent; honour Retry-After",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Internal": {
"description": "A fault on our side; quote `requestId` when reporting it.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Unavailable": {
"description": "The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); `retryable` says whether to try again.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "header",
"name": "X-Api-Key"
},
"userToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "fin_session_<opaque>",
"description": "A user's session token, from Create a session."
}
}
}
}