> ## Documentation Index > Fetch the complete documentation index at: https://docs.services.payward.com/llms.txt > Use this file to discover all available pages before exploring further. # List Assets > List assets available on the platform. The response includes each asset's symbol, type, display metadata, market data, and per-action availability. Use the optional filters to narrow the list by asset type or by whether an asset is enabled for swap trading, withdrawals, or deposits. ## OpenAPI ````yaml /api-reference/openapi_v3_pws.json get /v1/assets openapi: 3.1.0 info: title: Payward Services API description: >- The Payward Services (PWS) public API. PWS exposes Swaps (institutional FX-style trading), Conversions (rule-driven and one-shot fiat ↔ crypto value movement), retail-style Quotes and Price Trigger Swaps, end-user Users / Verifications, Funds (deposits, withdrawals, addresses, transactions), Portfolio, Earn, Reports, Webhooks, and Ramp (hosted fiat-to-crypto on-ramp checkout). All requests must be authenticated. All monetary values are decimal strings; all timestamps are ISO 8601 UTC. List endpoints are cursor-paginated. Errors follow a uniform shape (see `*ErrorResponse` schemas). version: v1 contact: name: Payward Services API Support url: https://docs.payward.com email: api-support@payward.com servers: - url: https://api.services.payward.com description: Production security: - ApiKey: [] ApiNonce: [] ApiSign: [] tags: - name: Users description: >- Users and headless-user onboarding flows that the partner manages. - **Create User** provisions a user with full identity verification fields collected up front. - **Create Headless User** provisions a lightweight user when your licensing agreement allows you to manage KYC data outside Payward. - **Get User** retrieves the user's profile, verification status, and required actions. - **Update User** updates user profile fields and may re-trigger verification. Use the returned user `id` for calls that require the user's identifier. - name: Assets description: >- Catalog of assets available on the platform with retail-display metadata (logos, market data, descriptions). - name: Conversions description: >- Rule-driven and one-shot fiat ↔ crypto value movement, including conversion rules, deposits, and whitelisted wallets. - name: Earn description: >- Manage auto-earn preferences and retrieve allocation and reward information. - name: Funds description: >- Deposits, withdrawals, addresses, methods, and the consolidated funding-transactions ledger. - name: Portfolio description: End-user portfolio summary, history, and transaction views. - name: Price Trigger Swaps description: Limit-style orders that execute when a configured price trigger is met. - name: On-chain Swaps description: >- Wallet-funded onchain quote trading for xStock and USDC pairs. On-chain quotes settle on-chain through the Payward on-chain proxy contract. - name: Ramp description: >- Hosted fiat-to-crypto on-ramp checkout: country / fiat / payment-method / cryptocurrency-asset discovery, transaction limits and prospective quotes, and the hosted checkout URL. - name: Reports description: Settlement and reconciliation reports for the partner. - name: Swaps description: >- Direct partner-to-Payward swap quotes and executions (institutional FX-style trading). - name: Verifications description: Identity verification (KYC) submission and status for end users. - name: Webhooks description: Manage webhook subscriptions for asynchronous event delivery. paths: /v1/assets: get: tags: - Assets summary: List Assets description: >- List assets available on the platform. The response includes each asset's symbol, type, display metadata, market data, and per-action availability. Use the optional filters to narrow the list by asset type or by whether an asset is enabled for swap trading, withdrawals, or deposits. operationId: listAssets parameters: - in: query name: country required: true description: >- ISO 3166-1 alpha-2 country code used to apply geo restrictions (e.g. `US`, `GB`). schema: type: string pattern: ^[A-Z]{2}$ example: US - in: query name: type description: >- Filter assets by classification. Repeat the parameter to filter on multiple types. schema: type: array default: [] items: type: string enum: - fiat - crypto - stablecoin - xstock minItems: 0 maxItems: 4 style: form explode: true - in: query name: swap_trading description: >- Filter to assets that are currently enabled for swap trading. Omit to ignore this dimension. schema: type: boolean - in: query name: withdraw description: >- Filter to assets that are currently enabled for withdrawal. Omit to ignore this dimension. schema: type: boolean - in: query name: deposit description: >- Filter to assets that are currently enabled for deposit. Omit to ignore this dimension. schema: type: boolean - in: query name: sort schema: default: market_cap_rank title: Sort Order type: string enum: - trending_rank - market_cap_rank - market_cap - price - volume.last_24h - price_change_percent.last_1h - price_change_percent.last_24h - price_change_percent.last_7d - price_change_percent.last_30d - price_change_percent.last_1y - symbol - name - listing_date description: >- Field to sort the results by. Use `sort_direction` to control ascending vs descending. Defaults to `market_cap_rank` (largest assets first when paired with `asc`). - in: query name: sort_direction description: >- Direction of the sort. Use `asc` for natural ascending order (rank 1 first, oldest first, lowest first); `desc` for the inverse. schema: type: string enum: - asc - desc default: asc - in: query name: page_size schema: description: >- Maximum number of results to return on a single page. Defaults to 20, maximum 100. type: integer format: int32 minimum: 1 maximum: 25 default: 20 style: form - in: query name: page_token schema: description: >- Opaque page token returned by a previous response's `next_page_token`. Omit to start from the beginning. type: string minLength: 1 maxLength: 256 style: form - in: query name: quote_symbol description: >- Ticker symbol of the fiat quote asset to use for valuations (e.g. `USD`, `EUR`). Defaults to `USD`. schema: type: string minLength: 3 maxLength: 16 default: USD example: USD - in: query name: quote_type description: >- Classification of the quote asset. Currently only `fiat` is supported. schema: type: string enum: - fiat default: fiat responses: '200': description: Response content: application/json: schema: type: object properties: data: description: The list of matching assets. type: array items: type: object properties: symbol: description: >- The ticker symbol of the asset (e.g. `BTC`, `ETH`, `USD`). allOf: - $ref: '#/components/schemas/AssetSymbol' type: description: Classification of the asset. type: string enum: - fiat - crypto - stablecoin - xstock example: crypto name: $ref: '#/components/schemas/EnglishName' status: description: >- Per-action availability for this asset. Each sub-block describes whether the asset is currently enabled for that flow and any restrictions that apply. type: object properties: swap_trading: description: Eligibility for swap trading. type: object properties: enabled: description: >- Whether the asset is currently enabled for swap trading. type: boolean disabled_against: description: >- Assets that cannot be paired with this one in a swap. Empty when the asset can be paired with any other tradable asset. type: array items: $ref: '#/components/schemas/AssetRef' required: - enabled - disabled_against withdraw: description: Eligibility for withdrawals. type: object properties: enabled: description: >- Whether the asset is currently enabled for withdrawal. type: boolean required: - enabled deposit: description: Eligibility for deposits. type: object properties: enabled: description: >- Whether the asset is currently enabled for deposit. type: boolean required: - enabled required: - swap_trading - withdraw - deposit listing_date: description: The date the asset was first listed on Payward. allOf: - $ref: '#/components/schemas/Date' logo: $ref: '#/components/schemas/Logo' decimals: description: >- Decimal precision for the asset across funding and swap operations. type: object properties: funding: $ref: '#/components/schemas/Uint8' description: >- Number of decimals supported when funding (depositing/withdrawing) this asset on its native protocol. swap: $ref: '#/components/schemas/Uint8' description: >- Number of decimals supported when trading this asset via swap. required: - funding - swap price: $ref: '#/components/schemas/BigDecimal' description: >- The latest price of the asset, in the requested `quote` asset. market_cap: description: >- The current market capitalization of the asset, in the requested `quote` asset. allOf: - $ref: '#/components/schemas/MarketCapValue' market_cap_rank: $ref: '#/components/schemas/Uint32' description: >- The rank of the asset based on the total market capitalization. trending_rank: $ref: '#/components/schemas/Uint32' description: >- The trending rank of the asset compared to all other trending assets. volume: description: >- Trading volume over recent windows, denominated in the requested `quote` asset. type: object properties: last_24h: $ref: '#/components/schemas/BigDecimal' description: >- The 24-hour trading volume for the asset, in the requested `quote` asset. supply: type: object properties: circulating: $ref: '#/components/schemas/BigDecimal' total: $ref: '#/components/schemas/TotalSupply' max: $ref: '#/components/schemas/MaxSupply' in_quote: description: >- Same supply figures valued at the current market price, denominated in the requested `quote` asset. type: object properties: circulating: $ref: '#/components/schemas/BigDecimal' description: >- Value of `supply.circulating` in the requested `quote` asset. total: $ref: '#/components/schemas/BigDecimal' description: >- Value of `supply.total` in the requested `quote` asset. max: $ref: '#/components/schemas/BigDecimal' description: >- Value of `supply.max` in the requested `quote` asset. description: >- Token supply figures. Quantities are denominated in the asset itself; their valuations in the requested `quote` asset live under `in_quote{}`. Absent when supply data is not applicable (e.g. fiat currencies). price_change_percent: type: object properties: last_1h: $ref: '#/components/schemas/Percentage' description: > The price change percentage over the last 1 hour. last_24h: $ref: '#/components/schemas/Percentage' description: > The price change percentage over the last 24 hours. last_7d: $ref: '#/components/schemas/Percentage' description: > The price change percentage over the last 7 days. last_30d: $ref: '#/components/schemas/Percentage' description: > The price change percentage over the last 30 days. last_1y: $ref: '#/components/schemas/Percentage' description: > The price change percentage over the last 1 year. description: >- Percentage change in the asset price over each rolling time window. ath: type: object properties: value: $ref: '#/components/schemas/AthValue' timestamp: description: >- Timestamp when the asset reached its all-time high price. allOf: - $ref: '#/components/schemas/DateTime' description: >- All-time-high price for the asset, with the timestamp it was reached. required: - symbol - type - name - logo - decimals - status quote_symbol: description: >- Quote asset symbol the prices are denominated in (resolved, defaults to USD). type: string example: USD quote_type: description: >- Classification of the quote asset (resolved, defaults to fiat). type: string enum: - fiat page_size: description: >- Maximum number of results to return on a single page. Defaults to 20, maximum 100. type: integer format: int32 sort: description: >- Field the results were sorted by (resolved, defaults to market_cap_rank). type: string enum: - trending_rank - market_cap_rank - market_cap - price - volume.last_24h - price_change_percent.last_1h - price_change_percent.last_24h - price_change_percent.last_7d - price_change_percent.last_30d - price_change_percent.last_1y - symbol - name - listing_date sort_direction: description: >- Direction the results were sorted in (resolved, defaults to asc). type: string enum: - asc - desc type: description: >- Asset classifications the listing was filtered to. Empty when no type filter was applied. type: array items: type: string enum: - fiat - crypto - stablecoin - xstock swap_trading: description: >- Swap-trading filter that was applied, echoed back. Absent when not filtered. type: boolean withdraw: description: >- Withdrawal filter that was applied, echoed back. Absent when not filtered. type: boolean deposit: description: >- Deposit filter that was applied, echoed back. Absent when not filtered. type: boolean next_page_token: description: >- Opaque token for the next page of results. Absent when there are no more pages. type: string minLength: 1 maxLength: 256 required: - data - quote_symbol - quote_type - page_size - sort - sort_direction example: data: - symbol: BTC type: crypto name: Bitcoin status: swap_trading: enabled: true disabled_against: [] withdraw: enabled: true deposit: enabled: true listing_date: '2013-09-12' logo: width: 64 height: 64 href: https://assets.payward.com/logos/btc.png type: image/png decimals: funding: 8 swap: 8 price: '67234.18' market_cap: '1325840000000' market_cap_rank: 1 trending_rank: 3 volume: last_24h: '38421000000' supply: circulating: '19720893' total: '19720893' max: '21000000' in_quote: circulating: '1325840000000' total: '1325840000000' max: '1411917780000' price_change_percent: last_1h: '0.21' last_24h: '1.84' last_7d: '-2.13' last_30d: '6.42' last_1y: '78.34' ath: value: '73750.07' timestamp: '2024-03-14T14:08:00Z' - symbol: ETH type: crypto name: Ethereum status: swap_trading: enabled: true disabled_against: - symbol: XLM type: crypto withdraw: enabled: true deposit: enabled: true listing_date: '2015-08-07' logo: width: 64 height: 64 href: https://assets.payward.com/logos/eth.png type: image/png decimals: funding: 8 swap: 8 price: '3251.40' market_cap: '391200000000' market_cap_rank: 2 trending_rank: 5 volume: last_24h: '17820000000' supply: circulating: '120284512' total: '120284512' max: null in_quote: circulating: '391200000000' total: '391200000000' max: null price_change_percent: last_1h: '-0.12' last_24h: '2.45' last_7d: '-1.07' last_30d: '4.91' last_1y: '52.18' ath: value: '4878.26' timestamp: '2021-11-10T14:24:00Z' next_page_token: eyJjdXJzb3IiOiJFVEgifQ== examples: first-page: summary: First page of assets across crypto, fiat, and xstock value: data: - symbol: BTC type: crypto name: Bitcoin status: swap_trading: enabled: true disabled_against: - symbol: USDT type: stablecoin name: Tether USD - symbol: SOL type: crypto name: Solana withdraw: enabled: true deposit: enabled: true logo: width: 400 height: 400 href: >- https://assets.kraken.com/marketing/web/icons-uni-webp/s_btc.webp type: image/webp decimals: funding: 8 swap: 10 listing_date: '2013-10-06' price: '62081' market_cap: '1244183483835' market_cap_rank: 1 trending_rank: 66 volume: last_24h: '53096507160' supply: circulating: '20038918' total: '20038918' max: '21000000' in_quote: circulating: '1244036068358' total: '1244036068358' max: '1303701000000' price_change_percent: last_1h: '-0.312449' last_24h: '-0.584983' last_7d: '-15.616145' last_30d: '-24.558477' last_1y: '-40.690849' ath: value: '126080' timestamp: '2025-10-06T18:57:42Z' - symbol: ETH type: crypto name: Ethereum status: swap_trading: enabled: true disabled_against: - symbol: USDT type: stablecoin name: Tether USD - symbol: SOL type: crypto name: Solana withdraw: enabled: true deposit: enabled: true logo: width: 400 height: 400 href: >- https://assets.kraken.com/marketing/web/icons-uni-webp/s_eth.webp type: image/webp decimals: funding: 10 swap: 10 listing_date: '2015-08-07' price: '1659.86' market_cap: '200269280850' market_cap_rank: 2 trending_rank: 55 volume: last_24h: '27036726996' price_change_percent: last_1h: '-0.5344' last_24h: '-4.915288' last_7d: '-17.382324' last_30d: '-31.162256' last_1y: '-36.021206' ath: value: '4946.05' timestamp: '2025-08-24T19:21:03Z' - symbol: USD type: fiat name: US Dollar status: swap_trading: enabled: true disabled_against: - symbol: AED type: fiat name: UAE Dirham - symbol: USDT type: stablecoin name: Tether USD withdraw: enabled: true deposit: enabled: true logo: width: 400 height: 400 href: >- https://assets.kraken.com/marketing/web/icons-uni-webp/s_usd.webp type: image/webp decimals: funding: 2 swap: 4 listing_date: '2013-10-06' - symbol: TSLAx type: xstock name: Tesla, Inc. status: swap_trading: enabled: true disabled_against: [] withdraw: enabled: true deposit: enabled: true logo: width: 400 height: 400 href: >- https://assets.kraken.com/marketing/web/icons-uni-webp/s_tslax.webp type: image/webp decimals: funding: 8 swap: 8 listing_date: '2025-06-30' price: '248.50' market_cap: '799000000000' market_cap_rank: 12 trending_rank: 8 volume: last_24h: '1203456789' price_change_percent: last_1h: '0.15' last_24h: '-1.02' last_7d: '3.44' last_30d: '-2.10' last_1y: '18.73' ath: value: '488.54' timestamp: '2025-01-31T20:00:00Z' quote_symbol: USD quote_type: fiat page_size: 20 sort: market_cap_rank sort_direction: asc next_page_token: MjoyRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4 last-page: summary: Last page of results — `nextPageToken` is omitted value: data: - symbol: GBP type: fiat name: Pound Sterling status: swap_trading: enabled: true disabled_against: [] withdraw: enabled: true deposit: enabled: true logo: width: 400 height: 400 href: >- https://assets.kraken.com/marketing/web/icons-uni-webp/s_gbp.webp type: image/webp decimals: funding: 2 swap: 4 listing_date: '2013-10-06' quote_symbol: USD quote_type: fiat page_size: 20 sort: market_cap_rank sort_direction: asc headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '401': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '403': description: Permission denied content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '408': description: Deadline exceeded content: application/json: schema: $ref: '#/components/schemas/DeadlineExceededErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/ConflictErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' Retry-After: $ref: '#/components/headers/RetryAfter' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' security: [] x-codeSamples: - lang: bash label: curl source: curl -X GET "https://api.services.payward.com/v1/assets" components: schemas: AssetSymbol: description: Ticker symbol of an asset (e.g. `BTC`, `USDC`, `EUR`). type: string minLength: 3 maxLength: 16 example: BTC EnglishName: description: >- Human-readable name of the asset (e.g. "Bitcoin" for BTC). Populated by the server in responses. type: string example: Bitcoin AssetRef: description: Reference to an asset by its ticker symbol and classification. type: object properties: symbol: description: Asset ticker symbol (e.g. "BTC", "USD", "TSLAx"). type: string type: description: Classification of the asset. type: string enum: - fiat - crypto - stablecoin - equity - xstock required: - symbol - type Date: type: string format: date description: A RFC 3339 date (without time) example: '2023-03-13' Logo: type: object properties: width: $ref: '#/components/schemas/Uint16' height: $ref: '#/components/schemas/Uint16' href: $ref: '#/components/schemas/Uri' type: $ref: '#/components/schemas/MediaRange' required: - height - href - width Uint8: type: integer format: uint8 minimum: 0 maximum: 255 BigDecimal: type: string format: decimal128 example: '1.23' pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 MarketCapValue: $ref: '#/components/schemas/BigDecimal' description: The market cap value, in the `quote` asset provided in the request. Uint32: type: integer format: uint32 minimum: 0 maximum: 4294967295 TotalSupply: $ref: '#/components/schemas/BigDecimal' description: | The total number of tokens that currently exist. MaxSupply: $ref: '#/components/schemas/BigDecimal' description: | The maximum number of tokens that can ever exist. Percentage: $ref: '#/components/schemas/BigDecimal' AthValue: $ref: '#/components/schemas/BigDecimal' description: | The all-time high price of the asset. DateTime: type: string format: date-time description: A RFC 3339 datetime example: '2023-03-13T12:34:56Z' ValidationErrorResponse: description: The request was rejected because the client supplied invalid input. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 400 instance: type: string code: type: string enum: - bad_request doc_url: type: string format: uri causes: type: array items: $ref: '#/components/schemas/ValidationCause' required: - type - status - instance - code required: - error UnauthenticatedErrorResponse: description: Authentication credentials were missing or invalid. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 401 instance: type: string code: type: string enum: - unauthenticated doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error ForbiddenErrorResponse: description: The caller is authenticated but is not allowed to perform this action. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 403 instance: type: string code: type: string enum: - forbidden doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error NotFoundErrorResponse: description: The requested resource does not exist. type: object properties: error: description: Error details. type: object properties: type: type: string enum: - request_error status: type: integer format: uint16 enum: - 404 instance: type: string code: type: string enum: - not_found doc_url: type: - string - 'null' format: uri required: - type - status - instance - code required: - error DeadlineExceededErrorResponse: description: The upstream request deadline was exceeded. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 504 instance: type: string code: type: string enum: - deadline_exceeded doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error ConflictErrorResponse: description: Generic state conflict that does not match a more specific 409 code. type: object properties: error: type: object properties: type: type: string enum: - state_error status: type: integer format: uint16 enum: - 409 instance: type: string code: type: string enum: - conflict doc_url: type: - string - 'null' required: - type - status - instance - code required: - error RateLimitErrorResponse: description: The request rate limit was exceeded. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 429 instance: type: string code: type: string enum: - resource_exhausted doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error InternalErrorResponse: description: An internal server error occurred. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 500 instance: type: string code: type: string enum: - internal doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error ServiceUnavailableErrorResponse: description: The service is temporarily unavailable. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 503 instance: type: string code: type: string enum: - unavailable doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error Uint16: type: integer format: uint16 minimum: 0 maximum: 65535 Uri: description: An RFC3986 URI type: string format: uri MediaRange: type: string format: media-range ValidationCause: description: One failed field-level validation rule. type: object properties: field: description: Dot-notation path to the offending request field. type: string message: description: Human-readable explanation of the failed validation rule. type: string required: - field - message headers: RequestId: description: >- Unique identifier for tracing this request across services. Include in support tickets. schema: type: string format: uuid example: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b RateLimitLimit: description: Total requests allowed in the current window. schema: type: integer example: 1000 RateLimitRemaining: description: Requests remaining in the current window. schema: type: integer example: 955 RateLimitReset: description: Unix timestamp (seconds) when the rate-limit window resets. schema: type: integer format: int64 example: 1713182400 StrictTransportSecurity: description: >- Enforces HTTPS for the configured period. Always `max-age=63072000; includeSubDomains; preload`. schema: type: string example: max-age=63072000; includeSubDomains; preload XContentTypeOptions: description: Disables MIME sniffing. Always `nosniff`. schema: type: string enum: - nosniff example: nosniff ContentSecurityPolicy: description: >- Prevents embedding and resource loading. Always `default-src 'none'; frame-ancestors 'none'`. schema: type: string example: default-src 'none'; frame-ancestors 'none' CacheControl: description: Prevents caching of sensitive financial data. Always `no-store`. schema: type: string enum: - no-store example: no-store RetryAfter: description: Seconds the client should wait before retrying. schema: type: integer example: 30 securitySchemes: ApiKey: type: apiKey name: API-Key in: header description: Your public API key. Identifies the partner making the request. ApiNonce: type: apiKey name: API-Nonce in: header description: Monotonically increasing nonce included in the request signature. ApiSign: type: apiKey name: API-Sign in: header description: HMAC signature over the request, computed with your private key. ````