{"openapi":"3.1.0","info":{"title":"Sunrise API","description":"Authenticated API for Sunrise.\n\nErrors carry a `code`; each code means one next step (see the Errors page). New codes may be added: for a code you don't know, get a new quote on a 409, and send the same request again on a 5xx from execute.\n\nA path that doesn't exist answers 404 `not_found`, and a method a path doesn't take answers 405 `method_not_allowed`.","version":"1.0.0"},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}],"paths":{"/v1/tokens":{"get":{"operationId":"getTokens","tags":["Tokens"],"summary":"List tokens","description":"Returns Sunrise-supported tokens on Solana.","responses":{"200":{"description":"Sunrise-supported tokens.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[true],"type":"boolean"},"data":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Number of tokens in this response."},"tokens":{"type":"array","items":{"type":"object","properties":{"chain":{"type":"string","description":"Blockchain where the token is issued."},"address":{"type":"string","description":"Solana mint address."},"symbol":{"type":"string","description":"Token ticker symbol."},"name":{"type":"string","description":"Display name of the token."},"decimals":{"type":"integer","minimum":0,"description":"Number of decimal places used by the token."},"platform":{"type":"string","description":"Platform associated with the token."},"assetClass":{"type":"string","description":"Asset classification of the token."},"issuer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issuer associated with the token, when available."},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Token icon URL, when available."},"tokenProgram":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Solana token program address, when available."}},"required":["chain","address","symbol","name","decimals","platform","assetClass","issuer","icon","tokenProgram"]},"description":"Sunrise tokens."},"pagination":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"description":"Maximum number of tokens returned per page."},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null when no page remains."}},"required":["limit","nextCursor"]}},"required":["count","tokens"]},"timestamp":{"type":"string"},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."}},"required":["success","data","timestamp","requestId"]}}}},"400":{"description":"invalid_request: A field or parameter is wrong or missing.","x-codes":["invalid_request"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"401":{"description":"unauthorized: The API key is missing or invalid.","x-codes":["unauthorized"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"403":{"description":"forbidden: The key can't make this request or use this route.","x-codes":["forbidden"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"429":{"description":"rate_limited: Too many requests; see Retry-After.\nverification_rate_limited: The API key's verification budget is used up; see Retry-After.","x-codes":["rate_limited","verification_rate_limited"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}},"headers":{"X-Sunrise-RateLimit-Scope":{"description":"Local per-key verification budget exceeded; back off requests for this key.","schema":{"type":"string","enum":["key"]}},"Retry-After":{"description":"Seconds to wait; present for local verification throttling.","schema":{"type":"integer","example":60}}}},"500":{"description":"internal_error: An unexpected error in the Sunrise API.","x-codes":["internal_error"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"502":{"description":"bad_gateway: A service behind the API failed.","x-codes":["bad_gateway"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"503":{"description":"service_unavailable: A service is temporarily unavailable.","x-codes":["service_unavailable"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}}},"parameters":[{"in":"query","name":"issuer","schema":{"type":"string"},"description":"Exact token issuer ID. Currently supported: backpack_securities. Unsupported issuers return 400. Keep unchanged across pages."},{"in":"query","name":"cursor","schema":{"type":"string","minLength":1,"maxLength":2048,"pattern":"^[A-Za-z0-9_-]+$"},"description":"Cursor returned by the previous page."}]}},"/v1/quotes":{"post":{"operationId":"getQuotes","tags":["Quotes"],"summary":"Get quotes","description":"Returns pricing quotes. Include wallet addresses to receive an unsigned transaction for execution.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"integratorFeeBps":{"type":"integer","minimum":0,"maximum":100,"description":"Integrator fee in basis points, 0–100 (25 = 0.25%). Fees must be enabled for your API key and the rate must stay within your approved limit. For a positive rate, provide integratorFeeRecipientAddress. Omit both fee fields or use 0 for no fee; 0 requires no fee setup or recipient. Charged in the input token. Currently supported only by rfq-fill for supported tokenized stocks against USDC; positive fees exclude all other routes, which appear in unavailableRoutes as integrator_fee_not_supported. Invalid fee terms return 400 invalid_request; unavailable fee access returns 400 integrator_fee_unavailable."},"integratorFeeRecipientAddress":{"type":"string","description":"Solana wallet receiving the integrator fee. Required with a positive integratorFeeBps. With 0 bps, a configured recipient can select an attribution override without charging a fee; otherwise default attribution applies. Use a fee recipient address approved for your API key. Passing this field without integratorFeeBps returns 400."},"fromToken":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[!-~]+$","description":"Input token mint address."},"toToken":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[!-~]+$","description":"Output token mint address."},"fromAddress":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[!-~]+$","description":"Wallet address sending the input token."},"toAddress":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[!-~]+$","description":"Wallet address receiving the output token."},"fromAmount":{"type":"string","maxLength":78,"pattern":"^[1-9]\\d*$","description":"Input amount in the token's base units."}},"required":["fromToken","toToken","fromAmount"],"additionalProperties":false}}},"description":"Quote parameters.","required":true},"responses":{"200":{"description":"Available quotes from the supported routes.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[true],"type":"boolean"},"data":{"type":"object","properties":{"quotes":{"type":"array","items":{"type":"object","properties":{"integratorFee":{"type":"object","properties":{"recipient":{"type":"string"},"bps":{"type":"integer","minimum":1,"maximum":100}},"required":["recipient","bps"],"description":"Integrator fee applied to this quote."},"quoteId":{"type":"string","minLength":1,"description":"Identifier to pass when executing the quote."},"routeName":{"type":"string","minLength":1,"description":"Liquidity route used by the quote."},"providerRequestId":{"type":"string","minLength":1,"description":"Provider request identifier to echo when executing."},"unsignedTransaction":{"type":"string","minLength":1,"description":"Base64-encoded Solana transaction to sign, when wallet addresses are provided."},"fromToken":{"type":"string","minLength":1,"description":"Input token mint address."},"toToken":{"type":"string","minLength":1,"description":"Output token mint address."},"fromAmount":{"type":"string","description":"Input amount in the token's base units."},"fromAmountUSD":{"type":"number","description":"Estimated USD value of the input."},"toAmount":{"type":"string","description":"Estimated output amount in the token's base units."},"toAmountUSD":{"type":"number","description":"Estimated USD value of the output."},"slippageBps":{"type":"integer","description":"Estimated slippage in basis points."},"estimatedDurationMs":{"type":"integer","description":"Estimated time for the order to complete after it is executed, in milliseconds."},"expiresAt":{"type":"string","format":"date-time","description":"When the quote expires, as an ISO 8601 time. Execute it before then; after it, get a new quote."}},"required":["quoteId","routeName","fromToken","toToken","fromAmount","toAmount"]},"description":"Available swap quotes."},"unavailableRoutes":{"type":"array","items":{"type":"object","properties":{"routeName":{"type":"string","minLength":1,"description":"The route that couldn't quote, as in a quote's routeName. Absent when no route was asked."},"code":{"type":"string","description":"Why there is no quote, from the error catalogue."},"message":{"type":"string","description":"The reason in plain words, safe to show the user."}},"required":["code","message"]},"description":"Each route that was asked and gave no quote, with why. A missing quote is not an error, so this is a 200."}},"required":["quotes","unavailableRoutes"]},"timestamp":{"type":"string"},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."}},"required":["success","data","timestamp","requestId"]}}}},"400":{"description":"invalid_request: A field or parameter is wrong or missing.\nintegrator_fee_unavailable: The API key is not configured for integrator fees.\ninvalid_token: A token address is not valid for the chain.\ntoken_not_supported: A valid token that Sunrise does not trade.","x-codes":["invalid_request","integrator_fee_unavailable","invalid_token","token_not_supported"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"401":{"description":"unauthorized: The API key is missing or invalid.","x-codes":["unauthorized"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"403":{"description":"forbidden: The key can't make this request or use this route.\ngeo_blocked: The user's region is not allowed.\naddress_blocked: The wallet address is on a sanctions list.\ntrading_halted: Trading in this asset is halted.","x-codes":["forbidden","geo_blocked","address_blocked","trading_halted"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"413":{"description":"payload_too_large: The request body is over the size limit.","x-codes":["payload_too_large"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"429":{"description":"rate_limited: Too many requests; see Retry-After.\nverification_rate_limited: The API key's verification budget is used up; see Retry-After.","x-codes":["rate_limited","verification_rate_limited"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}},"headers":{"X-Sunrise-RateLimit-Scope":{"description":"Local per-key verification budget exceeded; back off requests for this key.","schema":{"type":"string","enum":["key"]}},"Retry-After":{"description":"Seconds to wait; present for local verification throttling.","schema":{"type":"integer","example":60}}}},"500":{"description":"internal_error: An unexpected error in the Sunrise API.","x-codes":["internal_error"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"502":{"description":"bad_gateway: A service behind the API failed.","x-codes":["bad_gateway"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"503":{"description":"service_unavailable: A service is temporarily unavailable.","x-codes":["service_unavailable"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}}}}},"/v1/execute":{"post":{"operationId":"executeQuote","tags":["Execution"],"summary":"Execute quote","description":"Submits a signed transaction using the quote ID, route name, and optional provider request ID returned by the quote endpoint. Poll this endpoint with the same request until `done` is true. For routes that place orders, such as rfq-fill, the response lists the orders once the transaction is CONFIRMED, and `done` waits for every order to be final.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"signedTransaction":{"type":"string","minLength":4,"maxLength":5464,"pattern":"^(?=.{0,5460}$|.{5462}==$)(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","description":"Base64-encoded transaction signed by the connected Solana wallet.\n\n```ts\nimport { getBase64Decoder, getBase64Encoder } from \"@solana/kit\";\n\nconst [signed] = await wallet.features[\"solana:signTransaction\"].signTransaction({\n  account,\n  chain: \"solana:mainnet\",\n  transaction: new Uint8Array(getBase64Encoder().encode(quote.unsignedTransaction)),\n});\n\nconst signedTransaction = getBase64Decoder().decode(signed.signedTransaction);\n```"},"quoteId":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[!-~]+$","description":"Quote identifier returned by the quote endpoint."},"routeName":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[!-~]+$","description":"Liquidity route returned with the quote."},"providerRequestId":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[!-~]+$","description":"Provider request identifier returned with the quote."}},"required":["signedTransaction","quoteId","routeName"],"additionalProperties":false}}},"description":"Signed quote execution parameters.","required":true},"responses":{"200":{"description":"Transaction submission status.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[true],"type":"boolean"},"data":{"type":"object","properties":{"txHash":{"type":"string","description":"Submitted Solana transaction signature."},"status":{"enum":["CONFIRMED","SUBMITTED"],"type":"string","description":"Current transaction submission status."},"done":{"type":"boolean","description":"True once nothing will change: the transaction is CONFIRMED and every order is final. Poll with the same request until true."},"orders":{"type":"array","items":{"oneOf":[{"oneOf":[{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Sent, not landed yet.","enum":["PENDING"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."}},"required":["openTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Landed. Waits for a fill.","enum":["OPEN"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."}},"required":["openTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Filled. POST /v1/execute also reports a partial fill as FILLED.","enum":["FILLED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"fillTxHash":{"type":"string","minLength":1,"description":"Signature of the fill transaction."},"deliveredAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill delivered to the wallet, in raw base units of the output token."},"returnedAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill returned to the wallet, in raw base units of the input token."}},"required":["openTxHash","fillTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Filled in part. Final: the fill returned the rest of the input to the wallet.","enum":["PARTIALLY_FILLED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"fillTxHash":{"type":"string","minLength":1,"description":"Signature of the fill transaction."},"deliveredAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill delivered to the wallet, in raw base units of the output token."},"returnedAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill returned to the wallet, in raw base units of the input token."}},"required":["openTxHash","fillTxHash","returnedAmountRaw"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Cancelled. The input went back to the wallet.","enum":["CANCELLED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"cancelTxHash":{"type":"string","minLength":1,"description":"Signature of the cancel transaction."}},"required":["openTxHash","cancelTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"The fill was reversed. The input went back to the wallet.","enum":["REFUNDED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"refundTxHash":{"type":"string","minLength":1,"description":"Signature of the refund transaction."}},"required":["openTxHash","refundTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Nothing was traded.","enum":["FAILED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."}},"required":["openTxHash"]}},"required":["orderId","type","status","details"]}]}],"description":"An order the transaction placed. `type` fixes the shape of `details`; within a type, `status` does."},"description":"Orders the transaction placed, once it is CONFIRMED. Only for routes that place orders, such as rfq-fill."}},"required":["txHash","status","done"]},"timestamp":{"type":"string"},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."}},"required":["success","data","timestamp","requestId"]}}}},"400":{"description":"invalid_request: A field or parameter is wrong or missing.\ninvalid_transaction: The signed transaction is not the quote's transaction.","x-codes":["invalid_request","invalid_transaction"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"401":{"description":"unauthorized: The API key is missing or invalid.","x-codes":["unauthorized"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"403":{"description":"forbidden: The key can't make this request or use this route.\ngeo_blocked: The user's region is not allowed.\naddress_blocked: The wallet address is on a sanctions list.","x-codes":["forbidden","geo_blocked","address_blocked"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"409":{"description":"quote_expired: The quote was executed after expiresAt.\nprice_moved: The price moved between quote and execute.\norder_not_placed: The order was refused before it was sent, for a reason not known.\nmarket_closed: The market is outside its trading hours.\ntrading_paused: Trading is paused or under maintenance.\nno_liquidity: No one will fill the order right now.","x-codes":["quote_expired","price_moved","order_not_placed","market_closed","trading_paused","no_liquidity"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"413":{"description":"payload_too_large: The request body is over the size limit.","x-codes":["payload_too_large"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"422":{"description":"insufficient_sol: The paying wallet does not have enough SOL for the network fee or the rent of the accounts the order creates.\ninsufficient_balance: The wallet does not hold enough of the token being paid.\nsimulation_failed: The test run of the transaction failed; nothing was sent.\ntransaction_expired: The transaction was sent but never confirmed; nothing moved.\ntransaction_failed: The transaction was confirmed on-chain but failed.","x-codes":["insufficient_sol","insufficient_balance","simulation_failed","transaction_expired","transaction_failed"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"429":{"description":"rate_limited: Too many requests; see Retry-After.\nverification_rate_limited: The API key's verification budget is used up; see Retry-After.","x-codes":["rate_limited","verification_rate_limited"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}},"headers":{"X-Sunrise-RateLimit-Scope":{"description":"Local per-key verification budget exceeded; back off requests for this key.","schema":{"type":"string","enum":["key"]}},"Retry-After":{"description":"Seconds to wait; present for local verification throttling.","schema":{"type":"integer","example":60}}}},"500":{"description":"internal_error: An unexpected error in the Sunrise API.","x-codes":["internal_error"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"502":{"description":"bad_gateway: A service behind the API failed.","x-codes":["bad_gateway"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"503":{"description":"service_unavailable: A service is temporarily unavailable.\nexecute_status_unknown: The order may have been sent and could not be confirmed. Send the same request again; never sign a new quote.","x-codes":["service_unavailable","execute_status_unknown"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}}}}},"/v1/orders":{"get":{"operationId":"listOrders","tags":["Execution"],"summary":"List orders","description":"Lists a wallet's orders, newest placed first, each as POST /v1/execute lists it. Pass status to list only OPEN, FILLED, PARTIALLY_FILLED, CANCELLED or REFUNDED orders. Pages hold up to 100 orders; pass pagination.nextCursor back as cursor for the next page, keeping walletAddress unchanged; it is null on the last page. Orders appear up to about a minute after they land on chain, so the list never shows PENDING or FAILED.","responses":{"200":{"description":"A page of the wallet's orders.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[true],"type":"boolean"},"data":{"type":"object","properties":{"count":{"type":"number","description":"Number of orders in this response."},"orders":{"type":"array","items":{"oneOf":[{"oneOf":[{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Sent, not landed yet.","enum":["PENDING"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."}},"required":["openTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Landed. Waits for a fill.","enum":["OPEN"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."}},"required":["openTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Filled. POST /v1/execute also reports a partial fill as FILLED.","enum":["FILLED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"fillTxHash":{"type":"string","minLength":1,"description":"Signature of the fill transaction."},"deliveredAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill delivered to the wallet, in raw base units of the output token."},"returnedAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill returned to the wallet, in raw base units of the input token."}},"required":["openTxHash","fillTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Filled in part. Final: the fill returned the rest of the input to the wallet.","enum":["PARTIALLY_FILLED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"fillTxHash":{"type":"string","minLength":1,"description":"Signature of the fill transaction."},"deliveredAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill delivered to the wallet, in raw base units of the output token."},"returnedAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill returned to the wallet, in raw base units of the input token."}},"required":["openTxHash","fillTxHash","returnedAmountRaw"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Cancelled. The input went back to the wallet.","enum":["CANCELLED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"cancelTxHash":{"type":"string","minLength":1,"description":"Signature of the cancel transaction."}},"required":["openTxHash","cancelTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"The fill was reversed. The input went back to the wallet.","enum":["REFUNDED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"refundTxHash":{"type":"string","minLength":1,"description":"Signature of the refund transaction."}},"required":["openTxHash","refundTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Nothing was traded.","enum":["FAILED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."}},"required":["openTxHash"]}},"required":["orderId","type","status","details"]}]}],"description":"An order the transaction placed. `type` fixes the shape of `details`; within a type, `status` does."},"description":"The wallet's orders, newest placed first, as POST /v1/execute lists them."},"pagination":{"type":"object","properties":{"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null when no page remains."}},"required":["nextCursor"]}},"required":["count","orders","pagination"]},"timestamp":{"type":"string"},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."}},"required":["success","data","timestamp","requestId"]}}}},"400":{"description":"invalid_request: A field or parameter is wrong or missing.","x-codes":["invalid_request"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"401":{"description":"unauthorized: The API key is missing or invalid.","x-codes":["unauthorized"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"403":{"description":"forbidden: The key can't make this request or use this route.","x-codes":["forbidden"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"429":{"description":"rate_limited: Too many requests; see Retry-After.\nverification_rate_limited: The API key's verification budget is used up; see Retry-After.","x-codes":["rate_limited","verification_rate_limited"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}},"headers":{"X-Sunrise-RateLimit-Scope":{"description":"Local per-key verification budget exceeded; back off requests for this key.","schema":{"type":"string","enum":["key"]}},"Retry-After":{"description":"Seconds to wait; present for local verification throttling.","schema":{"type":"integer","example":60}}}},"500":{"description":"internal_error: An unexpected error in the Sunrise API.","x-codes":["internal_error"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"502":{"description":"bad_gateway: A service behind the API failed.","x-codes":["bad_gateway"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"503":{"description":"service_unavailable: A service is temporarily unavailable.","x-codes":["service_unavailable"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}}},"parameters":[{"in":"query","name":"walletAddress","schema":{"type":"string","pattern":"^[1-9A-HJ-NP-Za-km-z]{32,44}$"},"required":true,"description":"Solana wallet that placed the orders. Keep unchanged across pages."},{"in":"query","name":"status","schema":{"enum":["OPEN","FILLED","PARTIALLY_FILLED","CANCELLED","REFUNDED"],"type":"string"},"description":"Only orders with this status. Keep unchanged across pages."},{"in":"query","name":"cursor","schema":{"type":"string","pattern":"^[\\w-]{1,128}$"},"description":"Cursor returned by the previous page."}]}},"/v1/orders/{txHash}":{"get":{"operationId":"getOrder","tags":["Execution"],"summary":"Get order","description":"Returns every order a transaction placed, filled or cancelled, as POST /v1/execute lists them. Orders appear up to about a minute after they land on chain; until then this returns not_found, and POST /v1/execute with the original request reads them live.","responses":{"200":{"description":"The transaction's orders.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[true],"type":"boolean"},"data":{"type":"object","properties":{"txHash":{"type":"string","description":"The transaction signature that was looked up."},"orders":{"type":"array","items":{"oneOf":[{"oneOf":[{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Sent, not landed yet.","enum":["PENDING"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."}},"required":["openTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Landed. Waits for a fill.","enum":["OPEN"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."}},"required":["openTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Filled. POST /v1/execute also reports a partial fill as FILLED.","enum":["FILLED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"fillTxHash":{"type":"string","minLength":1,"description":"Signature of the fill transaction."},"deliveredAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill delivered to the wallet, in raw base units of the output token."},"returnedAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill returned to the wallet, in raw base units of the input token."}},"required":["openTxHash","fillTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Filled in part. Final: the fill returned the rest of the input to the wallet.","enum":["PARTIALLY_FILLED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"fillTxHash":{"type":"string","minLength":1,"description":"Signature of the fill transaction."},"deliveredAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill delivered to the wallet, in raw base units of the output token."},"returnedAmountRaw":{"type":"string","pattern":"^\\d+$","description":"What the fill returned to the wallet, in raw base units of the input token."}},"required":["openTxHash","fillTxHash","returnedAmountRaw"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Cancelled. The input went back to the wallet.","enum":["CANCELLED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"cancelTxHash":{"type":"string","minLength":1,"description":"Signature of the cancel transaction."}},"required":["openTxHash","cancelTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"The fill was reversed. The input went back to the wallet.","enum":["REFUNDED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."},"refundTxHash":{"type":"string","minLength":1,"description":"Signature of the refund transaction."}},"required":["openTxHash","refundTxHash"]}},"required":["orderId","type","status","details"]},{"type":"object","properties":{"orderId":{"type":"string","description":"The quote's `providerRequestId`."},"type":{"enum":["rfq"],"type":"string"},"status":{"description":"Nothing was traded.","enum":["FAILED"],"type":"string"},"details":{"type":"object","properties":{"openTxHash":{"type":"string","minLength":1,"description":"Signature of the transaction that opened the order."}},"required":["openTxHash"]}},"required":["orderId","type","status","details"]}]}],"description":"An order the transaction placed. `type` fixes the shape of `details`; within a type, `status` does."},"description":"Every order the transaction placed, filled or cancelled, as POST /v1/execute lists them."}},"required":["txHash","orders"]},"timestamp":{"type":"string"},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."}},"required":["success","data","timestamp","requestId"]}}}},"400":{"description":"invalid_request: A field or parameter is wrong or missing.","x-codes":["invalid_request"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"401":{"description":"unauthorized: The API key is missing or invalid.","x-codes":["unauthorized"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"403":{"description":"forbidden: The key can't make this request or use this route.","x-codes":["forbidden"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"404":{"description":"not_found: The path or token does not exist.","x-codes":["not_found"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"429":{"description":"rate_limited: Too many requests; see Retry-After.\nverification_rate_limited: The API key's verification budget is used up; see Retry-After.","x-codes":["rate_limited","verification_rate_limited"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}},"headers":{"X-Sunrise-RateLimit-Scope":{"description":"Local per-key verification budget exceeded; back off requests for this key.","schema":{"type":"string","enum":["key"]}},"Retry-After":{"description":"Seconds to wait; present for local verification throttling.","schema":{"type":"integer","example":60}}}},"500":{"description":"internal_error: An unexpected error in the Sunrise API.","x-codes":["internal_error"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"502":{"description":"bad_gateway: A service behind the API failed.","x-codes":["bad_gateway"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"503":{"description":"service_unavailable: A service is temporarily unavailable.","x-codes":["service_unavailable"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}}},"parameters":[{"in":"path","name":"txHash","schema":{"type":"string","pattern":"^[1-9A-HJ-NP-Za-km-z]{64,88}$"},"required":true,"description":"Signature of any of the order's transactions: its open, fill or cancel."}]}},"/v1/tokens/{address}":{"get":{"operationId":"getToken","tags":["Tokens"],"summary":"Get token","description":"Returns one Sunrise-supported Solana token by mint address. Pass \"native\" for SOL, the native Solana token. Includes the linked stock when available. Earnings, shares, dividends and market cap are all included for keys with stock data access when no flag is passed; once any flag is passed, only sections set to true are included. Sections that fail to load are omitted.","responses":{"200":{"description":"The requested token.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[true],"type":"boolean"},"data":{"type":"object","properties":{"token":{"type":"object","properties":{"chain":{"type":"string","description":"Blockchain where the token is issued."},"address":{"type":"string","description":"Solana mint address."},"symbol":{"type":"string","description":"Token ticker symbol."},"name":{"type":"string","description":"Display name of the token."},"decimals":{"type":"integer","minimum":0,"description":"Number of decimal places used by the token."},"platform":{"type":"string","description":"Platform associated with the token."},"assetClass":{"type":"string","description":"Asset classification of the token."},"issuer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issuer associated with the token, when available."},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Token icon URL, when available."},"tokenProgram":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Solana token program address, when available."},"stock":{"anyOf":[{"type":"object","properties":{"ticker":{"type":"string","description":"Ticker of the linked stock."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Currency associated with the linked stock, when available."},"exchange":{"anyOf":[{"type":"object","properties":{"marketIdentifierCode":{"type":"string","description":"Market Identifier Code for the exchange."},"name":{"type":"string","description":"Display name of the exchange."}},"required":["marketIdentifierCode","name"]},{"type":"null"}],"description":"Exchange where the linked stock is listed, when available."},"earnings":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"fiscalPeriodEndDate":{"type":"string","format":"date"},"reportDate":{"type":"string","format":"date"},"reportSession":{"enum":["pre-market","post-market","during-market","unknown"],"type":"string"},"eps":{"type":"object","properties":{"reported":{"type":"number","description":"Reported earnings per share."},"estimated":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Consensus EPS estimate, or null when unavailable."},"surpriseAmount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Reported minus estimated EPS, or null without an estimate."},"surprisePercent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"EPS surprise as a percentage of the estimate, or null without an estimate or when the estimate is within 0.05 of zero."}},"required":["reported","estimated","surpriseAmount","surprisePercent"]}},"required":["fiscalPeriodEndDate","reportDate","reportSession","eps"]},{"type":"object","properties":{"fiscalPeriodEndDate":{"type":"string","format":"date"},"reportDate":{"type":"string","format":"date"},"reportSession":{"enum":["pre-market","post-market","during-market","unknown"],"type":"string"},"eps":{"type":"object","properties":{"reported":{"type":"null","description":"Null until the company reports."},"estimated":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Consensus EPS estimate, or null when unavailable."},"surpriseAmount":{"type":"null","description":"Null until the company reports."},"surprisePercent":{"type":"null","description":"Null until the company reports."}},"required":["reported","estimated","surpriseAmount","surprisePercent"]}},"required":["fiscalPeriodEndDate","reportDate","reportSession","eps"]}]},"maxItems":5,"description":"Up to the four most recently reported quarters, oldest first, then the next scheduled report when one is known. Only that last entry can have eps.reported null."},"dividends":{"type":"array","items":{"type":"object","properties":{"exDividendDate":{"type":"string","format":"date"},"declarationDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recordDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"paymentDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"amountPerShare":{"type":"number","minimum":0}},"required":["exDividendDate","declarationDate","recordDate","paymentDate","amountPerShare"]},"description":"Recent dividends, newest first."},"shares":{"type":"object","properties":{"outstanding":{"anyOf":[{"type":"object","properties":{"date":{"type":"string","format":"date"},"basic":{"anyOf":[{"type":"number"},{"type":"null"}]},"diluted":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["date","basic","diluted"]},{"type":"null"}],"description":"Latest reported shares outstanding, or null when unavailable."}},"required":["outstanding"]},"marketCap":{"type":"number","minimum":0,"description":"Market capitalization of the linked stock."}},"required":["ticker","currency","exchange"]},{"type":"null"}],"description":"Linked stock, or null for tokens without one."}},"required":["chain","address","symbol","name","decimals","platform","assetClass","issuer","icon","tokenProgram","stock"]}},"required":["token"]},"timestamp":{"type":"string"},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."}},"required":["success","data","timestamp","requestId"]}}}},"400":{"description":"invalid_request: A field or parameter is wrong or missing.\ninvalid_token: A token address is not valid for the chain.","x-codes":["invalid_request","invalid_token"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"401":{"description":"unauthorized: The API key is missing or invalid.","x-codes":["unauthorized"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"403":{"description":"forbidden: The key can't make this request or use this route.","x-codes":["forbidden"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"404":{"description":"not_found: The path or token does not exist.","x-codes":["not_found"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"429":{"description":"rate_limited: Too many requests; see Retry-After.\nverification_rate_limited: The API key's verification budget is used up; see Retry-After.","x-codes":["rate_limited","verification_rate_limited"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}},"headers":{"X-Sunrise-RateLimit-Scope":{"description":"Local per-key verification budget exceeded; back off requests for this key.","schema":{"type":"string","enum":["key"]}},"Retry-After":{"description":"Seconds to wait; present for local verification throttling.","schema":{"type":"integer","example":60}}}},"500":{"description":"internal_error: An unexpected error in the Sunrise API.","x-codes":["internal_error"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"502":{"description":"bad_gateway: A service behind the API failed.","x-codes":["bad_gateway"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}},"503":{"description":"service_unavailable: A service is temporarily unavailable.","x-codes":["service_unavailable"],"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"enum":[false],"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","description":"One of the codes this response lists in its description and x-codes."},"message":{"type":"string"},"details":{"type":"object","properties":{"txHash":{"type":"string","description":"The hash of the order's transaction, which was sent to the chain."},"fields":{"type":"array","items":{"type":"string"},"description":"The request fields that aren't valid."}},"required":[],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false},"requestId":{"type":"string","description":"Identifies this request; also sent as the X-Request-Id header. Quote it when asking Sunrise about a request."},"timestamp":{"type":"string"}},"required":["success","error","requestId","timestamp"],"additionalProperties":false}}}}},"parameters":[{"in":"path","name":"address","schema":{"type":"string"},"required":true,"description":"Solana mint address, or \"native\" for SOL."},{"in":"query","name":"includeEarnings","schema":{"enum":["true","false"],"type":"string"},"description":"When true, include the four most recently reported and the next upcoming earnings for the linked stock. When no flag is passed, every section is included for keys with stock data access; once any flag is passed, only sections set to true are included. Omitted for tokens without a linked stock or when the section fails to load."},{"in":"query","name":"includeShares","schema":{"enum":["true","false"],"type":"string"},"description":"When true, include the linked stock's latest shares outstanding. When no flag is passed, every section is included for keys with stock data access; once any flag is passed, only sections set to true are included. Omitted for tokens without a linked stock or when the section fails to load."},{"in":"query","name":"includeDividends","schema":{"enum":["true","false"],"type":"string"},"description":"When true, include the linked stock's recent dividends. When no flag is passed, every section is included for keys with stock data access; once any flag is passed, only sections set to true are included. Omitted for tokens without a linked stock or when the section fails to load."},{"in":"query","name":"includeMarketCap","schema":{"enum":["true","false"],"type":"string"},"description":"When true, include the linked stock's market capitalization. When no flag is passed, every section is included for keys with stock data access; once any flag is passed, only sections set to true are included. Omitted for tokens without a linked stock or when the section fails to load."}]}}},"servers":[{"url":"https://api.sunrise.xyz"}]}