REST API for the Fordefi institutional MPC wallet platform: vaults, addresses, assets, transactions (create/approve/sign/broadcast), swaps, batch transactions, address book, users and groups, webhooks, exports, and audit log. OpenAPI 3.1.0, 75 operations across 17 resource groups.
{"openapi":"3.1.0","info":{"title":"Fordefi API","version":"0.2.0"},"servers":[{"url":"https://api.fordefi.com/","description":"Production"}],"paths":{"/api/v1/blockchains":{"get":{"tags":["Blockchains"],"summary":"List Chains","description":"Get a list of supported blockchains.","operationId":"list_chains_api_v1_blockchains_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number to fetch.","default":1,"title":"Page"},"description":"The page number to fetch."},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":0,"description":"The number of items per page.","default":50,"title":"Size"},"description":"The number of items per page."},{"name":"skip_count","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to skip counting the total number of items.","default":false,"title":"Skip Count"},"description":"Whether to skip counting the total number of items."},{"name":"chain_types","in":"query","required":false,"schema":{"title":"Chain Types","type":"array","items":{"$ref":"#/components/schemas/ChainType"}}},{"name":"sources","in":"query","required":false,"schema":{"description":"The source of the chain. Can be:<ul><li>`default`: Chains with built-in support on Fordefi's platform.<li>`custom`: User-added chains with support on Fordefi's platform.</ul>","title":"Sources","type":"array","items":{"$ref":"#/components/schemas/ChainSource"}},"description":"The source of the chain. Can be:<ul><li>`default`: Chains with built-in support on Fordefi's platform.<li>`custom`: User-added chains with support on Fordefi's platform.</ul>"},{"name":"include_mainnets","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Mainnets"}},{"name":"include_testnets","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Testnets"}},{"name":"include_exchanges","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Exchanges"}},{"name":"show_all","in":"query","required":false,"schema":{"type":"boolean","description":"Include all chains in the response.","default":false,"title":"Show All"},"description":"Include all chains in the response."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockchainsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"401":{"description":"Unauthorized User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"403":{"description":"Forbidden User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"429":{"description":"Rate Limit Exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}}}}},"/api/v1/blockchains/suggested-fees":{"get":{"tags":["Blockchains"],"summary":"Get Suggested Fees","description":"Get the suggested fees in a specific network.","operationId":"get_suggested_fees_api_v1_blockchains_suggested_fees_get","parameters":[{"name":"chains","in":"query","required":false,"schema":{"title":"Chains","type":"array","items":{"type":"string","minLength":1,"description":"The unique chain ID. </br>Can be either one of those supported by the default chains below or a custom numeric EVM chain ID `evm_<chain_id>` if one was added to your organization. <ul><li>`\"aptos_mainnet\"`</li><li>`\"aptos_testnet\"`</li><li>`\"aptos_movement_mainnet\"`</li><li>`\"aptos_movement_testnet\"`</li><li>`\"arch_mainnet\"`</li><li>`\"arch_testnet\"`</li><li>`\"canton_mainnet\"`</li><li>`\"cosmos_agoric-3\"`</li><li>`\"cosmos_akashnet-2\"`</li><li>`\"cosmos_archway-1\"`</li><li>`\"cosmos_axelar-dojo-1\"`</li><li>`\"cosmos_bbn-1\"`</li><li>`\"cosmos_celestia\"`</li><li>`\"cosmos_cosmoshub-4\"`</li><li>`\"cosmos_dydx-mainnet-1\"`</li><li>`\"cosmos_dydx-testnet-4\"`</li><li>`\"cosmos_dymension_1100-1\"`</li><li>`\"cosmos_injective-1\"`</li><li>`\"cosmos_neutron-1\"`</li><li>`\"cosmos_nillion-1\"`</li><li>`\"cosmos_noble-1\"`</li><li>`\"cosmos_osmosis-1\"`</li><li>`\"cosmos_provider\"`</li><li>`\"cosmos_ssc-1\"`</li><li>`\"cosmos_pacific-1\"`</li><li>`\"cosmos_stride-1\"`</li><li>`\"cosmos_thorchain-1\"`</li><li>`\"cosmos_mantra-1\"`</li><li>`\"exchange_binance\"`</li><li>`\"exchange_bybit\"`</li><li>`\"exchange_coinbase_international\"`</li><li>`\"exchange_coinbase_us\"`</li><li>`\"exchange_okx\"`</li><li>`\"exchange_kraken\"`</li><li>`\"ripple_mainnet\"`</li><li>`\"solana_mainnet\"`</li><li>`\"solana_devnet\"`</li><li>`\"solana_eclipse_mainnet\"`</li><li>`\"solana_fogo_mainnet\"`</li><li>`\"solana_fogo_testnet\"`</li><li>`\"stacks_mainnet\"`</li><li>`\"starknet_mainnet\"`</li><li>`\"stellar_mainnet\"`</li><li>`\"sui_mainnet\"`</li><li>`\"sui_testnet\"`</li><li>`\"ton_mainnet\"`</li><li>`\"tron_mainnet\"`</li><li>`\"tron_shasta\"`</li><li>`\"bitcoin_mainnet\"`</li><li>`\"bitcoin_testnet\"`</li><li>`\"bitcoin_testnet_v4\"`</li><li>`\"dogecoin_mainnet\"`</li><li>`\"bitcoin_cash_mainnet\"`</li><li>`\"pearl_testnet\"`</li><li>`\"pearl_mainnet\"`</li><li>`\"evm_1\"`</li><li>`\"evm_5\"`</li><li>`\"evm_10\"`</li><li>`\"evm_14\"`</li><li>`\"evm_16\"`</li><li>`\"evm_30\"`</li><li>`\"evm_56\"`</li><li>`\"evm_100\"`</li><li>`\"evm_130\"`</li><li>`\"evm_137\"`</li><li>`\"evm_143\"`</li><li>`\"evm_146\"`</li><li>`\"evm_169\"`</li><li>`\"evm_196\"`</li><li>`\"evm_250\"`</li><li>`\"evm_324\"`</li><li>`\"evm_999\"`</li><li>`\"evm_1030\"`</li><li>`\"evm_1100\"`</li><li>`\"evm_1101\"`</li><li>`\"evm_1329\"`</li><li>`\"evm_1337\"`</li><li>`\"evm_1666\"`</li><li>`\"evm_1672\"`</li><li>`\"evm_1729\"`</li><li>`\"evm_2222\"`</li><li>`\"evm_4200\"`</li><li>`\"evm_4217\"`</li><li>`\"evm_4663\"`</li><li>`\"evm_5000\"`</li><li>`\"evm_7000\"`</li><li>`\"evm_7700\"`</li><li>`\"evm_8453\"`</li><li>`\"evm_8818\"`</li><li>`\"evm_8819\"`</li><li>`\"evm_9745\"`</li><li>`\"evm_16661\"`</li><li>`\"evm_17000\"`</li><li>`\"evm_80001\"`</li><li>`\"evm_80094\"`</li><li>`\"evm_42161\"`</li><li>`\"evm_43113\"`</li><li>`\"evm_43114\"`</li><li>`\"evm_57073\"`</li><li>`\"evm_59144\"`</li><li>`\"evm_81457\"`</li><li>`\"evm_421614\"`</li><li>`\"evm_534352\"`</li><li>`\"evm_660279\"`</li><li>`\"evm_747474\"`</li><li>`\"evm_810180\"`</li><li>`\"evm_11155111\"`</li><li>`\"evm_ethereum_mainnet\"`</li><li>`\"evm_ethereum_goerli\"`</li><li>`\"evm_optimism_mainnet\"`</li><li>`\"evm_flare_mainnet\"`</li><li>`\"evm_flare_testnet\"`</li><li>`\"evm_rootstock_mainnet\"`</li><li>`\"evm_bsc_mainnet\"`</li><li>`\"evm_gnosis_mainnet\"`</li><li>`\"evm_unichain_mainnet\"`</li><li>`\"evm_polygon_mainnet\"`</li><li>`\"evm_monad_mainnet\"`</li><li>`\"evm_sonic_mainnet\"`</li><li>`\"evm_manta_pacific_mainnet\"`</li><li>`\"evm_x_layer_mainnet\"`</li><li>`\"evm_fantom_mainnet\"`</li><li>`\"evm_zksync_era_mainnet\"`</li><li>`\"evm_hyperevm_mainnet\"`</li><li>`\"evm_conflux_mainnet\"`</li><li>`\"evm_dymension_mainnet\"`</li><li>`\"evm_polygon_zkevm_mainnet\"`</li><li>`\"evm_sei_mainnet\"`</li><li>`\"evm_hypercore_mainnet\"`</li><li>`\"evm_aster_mainnet\"`</li><li>`\"evm_pharos_mainnet\"`</li><li>`\"evm_reya_mainnet\"`</li><li>`\"evm_kava_mainnet\"`</li><li>`\"evm_merlin_mainnet\"`</li><li>`\"evm_tempo_mainnet\"`</li><li>`\"evm_robinhood_mainnet\"`</li><li>`\"evm_mantle_mainnet\"`</li><li>`\"evm_zeta_mainnet\"`</li><li>`\"evm_canto_mainnet\"`</li><li>`\"evm_base_mainnet\"`</li><li>`\"evm_clink_mainnet\"`</li><li>`\"evm_clink_testnet\"`</li><li>`\"evm_plasma_mainnet\"`</li><li>`\"evm_zero_gravity_mainnet\"`</li><li>`\"evm_ethereum_holesky\"`</li><li>`\"evm_polygon_mumbai\"`</li><li>`\"evm_berachain_mainnet\"`</li><li>`\"evm_arbitrum_mainnet\"`</li><li>`\"evm_avalanche_fuji\"`</li><li>`\"evm_avalanche_chain\"`</li><li>`\"evm_ink_mainnet\"`</li><li>`\"evm_linea_mainnet\"`</li><li>`\"evm_blast_mainnet\"`</li><li>`\"evm_arbitrum_sepolia\"`</li><li>`\"evm_scroll_mainnet\"`</li><li>`\"evm_xai_mainnet\"`</li><li>`\"evm_katana_mainnet\"`</li><li>`\"evm_zklink_nova_mainnet\"`</li><li>`\"evm_ethereum_sepolia\"`</li></ul>","title":"ChainUniqueId"}}},{"name":"chain_types","in":"query","required":false,"schema":{"title":"Chain Types","type":"array","items":{"$ref":"#/components/schemas/ChainType"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSuggestedFeesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"401":{"description":"Unauthorized User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"403":{"description":"Forbidden User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"429":{"description":"Rate Limit Exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}}}}},"/api/v1/users":{"get":{"tags":["Users"],"summary":"List Users","description":"Get a list of users in the organization.","operationId":"list_users_api_v1_users_get","parameters":[{"name":"sort_by","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserSortableFields"},"title":"Sort By"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":400,"minimum":0,"description":"The number of items per page.","default":50,"title":"Size"},"description":"The number of items per page."},{"name":"skip_count","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to skip counting the total number of items.","default":false,"title":"Skip Count"},"description":"Whether to skip counting the total number of items."},{"name":"types","in":"query","required":false,"schema":{"description":"The types of the users to filter on.","title":"Types","type":"array","items":{"$ref":"#/components/schemas/UserType"}},"description":"The types of the users to filter on."},{"name":"roles","in":"query","required":false,"schema":{"description":"The roles of the users to filter on.","title":"Roles","type":"array","items":{"$ref":"#/components/schemas/UserRole"}},"description":"The roles of the users to filter on."},{"name":"states","in":"query","required":false,"schema":{"description":"The states of the users to filter on. Is one of: <ul><li>`active`: The user can perform all actions in the Fordefi platform.<li>`onboarding_pending_code_generation`: The user has been approved but still needs to generate a code for the user.<li>`onboarding_pending_activation`: The user has been generated a code but still needs to activate the account with it.<li>`deleted`: The user has been deleted.</ul>","title":"States","type":"array","items":{"$ref":"#/components/schemas/UserState"}},"description":"The states of the users to filter on. Is one of: <ul><li>`active`: The user can perform all actions in the Fordefi platform.<li>`onboarding_pending_code_generation`: The user has been approved but still needs to generate a code for the user.<li>`onboarding_pending_activation`: The user has been generated a code but still needs to activate the account with it.<li>`deleted`: The user has been deleted.</ul>"},{"name":"include_deleted","in":"query","required":false,"schema":{"description":"`True` to include deleted users in the response, `False` otherwise.","default":false,"title":"Include Deleted","type":"boolean"},"description":"`True` to include deleted users in the response, `False` otherwise."},{"name":"names","in":"query","required":false,"schema":{"description":"The names of the users.","title":"Names","type":"array","items":{"type":"string"}},"description":"The names of the users."},{"name":"emails","in":"query","required":false,"schema":{"description":"The emails of the users.","title":"Emails","type":"array","items":{"type":"string"}},"description":"The emails of the users."},{"name":"user_ids","in":"query","required":false,"schema":{"description":"The unique identifiers of the users.","title":"User Ids","type":"array","items":{"type":"string","format":"uuid"}},"description":"The unique identifiers of the users."},{"name":"external_ids","in":"query","required":false,"schema":{"description":"The IDs that you assign to the end user.","title":"External Ids","type":"array","items":{"type":"string"}},"description":"The IDs that you assign to the end user."},{"name":"group_ids","in":"query","required":false,"schema":{"description":"The unique identifiers of the user groups.","title":"Group Ids","type":"array","items":{"type":"string","format":"uuid"}},"description":"The unique identifiers of the user groups."},{"name":"group_ids__not","in":"query","required":false,"schema":{"description":"The unique identifiers of the user groups to exclude.","title":"Group Ids Not","type":"array","items":{"type":"string","format":"uuid"}},"description":"The unique identifiers of the user groups to exclude."},{"name":"states_on_groups","in":"query","required":false,"schema":{"description":"The states of the user groups to filter group_ids on. Is one of: <ul><li>`active`: The user group is active.<li>`pending_addition`: The user is pending to be added to the group.<li>`pending_removal`: The user is pending to be removed from the group.</ul>","title":"States On Groups","type":"array","items":{"$ref":"#/components/schemas/UserStateOnGroup"}},"description":"The states of the user groups to filter group_ids on. Is one of: <ul><li>`active`: The user group is active.<li>`pending_addition`: The user is pending to be added to the group.<li>`pending_removal`: The user is pending to be removed from the group.</ul>"},{"name":"exclude_user_ids","in":"query","required":false,"schema":{"description":"The user IDs to exclude.","title":"Exclude User Ids","type":"array","items":{"type":"string","format":"uuid"}},"description":"The user IDs to exclude."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"401":{"description":"Unauthorized User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"403":{"description":"Forbidden User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"429":{"description":"Rate Limit Exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}}}}},"/api/v1/users/{id}":{"get":{"tags":["Users"],"summary":"Get User","description":"Gets the user that corresponds to the given ID.","operationId":"get_user_api_v1_users__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"ID of the user to retrieve.","title":"Id"},"description":"ID of the user to retrieve."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"401":{"description":"Unauthorized User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"403":{"description":"Forbidden User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"429":{"description":"Rate Limit Exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceError"}}}}}}},"/api/v1/user-groups":{"get":{"tags":["User Groups"],"summary":"List User Groups","description":"Get a list of user groups","operationId":"list_user_groups_api_v1_user_groups_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number to fetch.","default":1,"title":"Page"},"description":"The page number to fetch."},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":0,"description":"The number of items per page.","default":50,"title":"Size"},"description":"The number of items per page."},{"name":"skip_count","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to skip counting the total number of items.","default":false,"title":"Skip Count"},"description":"Whether to skip counting the total number of items."},{"name":"states","in":"query","required":false,"schema":{"title":"States","type":"array","items":{"$ref":"#/components/schemas/UserGroupState"}}},{"name":"user_group_ids","in":"query","required":false,"schema":{"title":"User Group Ids","type":"array","items":{"type":"string","format":"uuid"}}},{"name":"user_ids","in":"query","required":false,"schema":{"title":"User Ids","type":"array","items":{"type":"string","format":"uuid"}}},{"name":"modified_by","in":"query","required":false,"schema":{"title":"Modified By","type":"array","items":{"type":"string","format":"uuid"}}},{"name":"name","in":"query","required":false,"schema":{"title":"Name","type":"string","minLength":1}},{"name":"search","in":"query","required":false,"schema":{"title":"Search","type":"string","minLength":1}},{"name":"exclude_user_group_ids","in":"query","required":false,"schema":{"description":"The group IDs to exclude.","title":"Exclude User Group Ids","type":"array","items":{"type":"string","format":"uuid"}},"description":"The group IDs to exclude."},{"name":"sort_by","in":"query","required":false,"schema":{"title":"Sort By","type":"array","items":{"$ref":"#/components/schemas/UserGroupSortableFields"}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUserGroupsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"401":{"description":"Unauthorized User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"403":{"description":"Forbidden User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"429":{"description":"Rate Limit Exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}}}}},"/api/v1/user-groups/{id}":{"get":{"tags":["User Groups"],"summary":"Get User Group","description":"Retrieve user group details","operationId":"get_user_group_api_v1_user_groups__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"ID of the user group to retrieve.","title":"Id"},"description":"ID of the user group to retrieve."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserGroupResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"401":{"description":"Unauthorized User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"403":{"description":"Forbidden User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"429":{"description":"Rate Limit Exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceError"}}}}}}},"/api/v1/vaults":{"get":{"tags":["Vaults"],"summary":"List Vaults","description":"Get a list of all vaults in an organization.","operationId":"list_vaults_api_v1_vaults_get","parameters":[{"name":"sort_by","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListVaultsSortableFields"},"title":"Sort By"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number to fetch.","default":1,"title":"Page"},"description":"The page number to fetch."},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":0,"description":"The number of items per page.","default":50,"title":"Size"},"description":"The number of items per page."},{"name":"skip_count","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to skip counting the total number of items.","default":false,"title":"Skip Count"},"description":"Whether to skip counting the total number of items."},{"name":"vault_ids","in":"query","required":false,"schema":{"description":"Vault IDs to filter on.","title":"Vault Ids","type":"array","items":{"type":"string","format":"uuid"}},"description":"Vault IDs to filter on."},{"name":"names","in":"query","required":false,"schema":{"description":"List of full names to filter on.","title":"Names","type":"array","items":{"type":"string"}},"description":"List of full names to filter on."},{"name":"vault_types","in":"query","required":false,"schema":{"description":"Vault types to filter on.","title":"Vault Types","type":"array","items":{"$ref":"#/components/schemas/VaultType"}},"description":"Vault types to filter on."},{"name":"vault_states","in":"query","required":false,"schema":{"description":"Vault states to filter on.","title":"Vault States","type":"array","items":{"$ref":"#/components/schemas/VaultState"}},"description":"Vault states to filter on."},{"name":"key_holder_ids","in":"query","required":false,"schema":{"description":"List of key holder IDs to filter on.","title":"Key Holder Ids","type":"array","items":{"type":"string","format":"uuid"}},"description":"List of key holder IDs to filter on."},{"name":"vault_group_ids","in":"query","required":false,"schema":{"description":"List of vault group IDs to filter on. Filter applies to current and pending vault groups.","title":"Vault Group Ids","type":"array","items":{"type":"string","format":"uuid"}},"description":"List of vault group IDs to filter on. Filter applies to current and pending vault groups."},{"name":"exclude_vault_group_ids","in":"query","required":false,"schema":{"description":"List of vault group IDs to exclude.","title":"Exclude Vault Group Ids","type":"array","items":{"type":"string","format":"uuid"}},"description":"List of vault group IDs to exclude."},{"name":"exclude_vault_ids","in":"query","required":false,"schema":{"description":"Vault IDs to exclude.","title":"Exclude Vault Ids","type":"array","items":{"type":"string","format":"uuid"}},"description":"Vault IDs to exclude."},{"name":"origin_type","in":"query","required":false,"schema":{"description":"Origin type to filter on.","title":"Origin Type","$ref":"#/components/schemas/VaultOriginType"},"description":"Origin type to filter on."},{"name":"account_addresses","in":"query","required":false,"schema":{"description":"List of account addresses to filter on.","title":"Account Addresses","type":"array","items":{"type":"string"}},"description":"List of account addresses to filter on."},{"name":"positive_native_balance_chain_ids","in":"query","required":false,"schema":{"description":"List of chain IDs to fetch native assets for. Only vaults with positive native balance in any of these chains will be included in native_assets response.","title":"Positive Native Balance Chain Ids","type":"array","items":{"type":"string","minLength":1,"description":"The unique chain ID. </br>Can be either one of those supported by the default chains below or a custom numeric EVM chain ID `evm_<chain_id>` if one was added to your organization. <ul><li>`\"aptos_mainnet\"`</li><li>`\"aptos_testnet\"`</li><li>`\"aptos_movement_mainnet\"`</li><li>`\"aptos_movement_testnet\"`</li><li>`\"arch_mainnet\"`</li><li>`\"arch_testnet\"`</li><li>`\"canton_mainnet\"`</li><li>`\"cosmos_agoric-3\"`</li><li>`\"cosmos_akashnet-2\"`</li><li>`\"cosmos_archway-1\"`</li><li>`\"cosmos_axelar-dojo-1\"`</li><li>`\"cosmos_bbn-1\"`</li><li>`\"cosmos_celestia\"`</li><li>`\"cosmos_cosmoshub-4\"`</li><li>`\"cosmos_dydx-mainnet-1\"`</li><li>`\"cosmos_dydx-testnet-4\"`</li><li>`\"cosmos_dymension_1100-1\"`</li><li>`\"cosmos_injective-1\"`</li><li>`\"cosmos_neutron-1\"`</li><li>`\"cosmos_nillion-1\"`</li><li>`\"cosmos_noble-1\"`</li><li>`\"cosmos_osmosis-1\"`</li><li>`\"cosmos_provider\"`</li><li>`\"cosmos_ssc-1\"`</li><li>`\"cosmos_pacific-1\"`</li><li>`\"cosmos_stride-1\"`</li><li>`\"cosmos_thorchain-1\"`</li><li>`\"cosmos_mantra-1\"`</li><li>`\"exchange_binance\"`</li><li>`\"exchange_bybit\"`</li><li>`\"exchange_coinbase_international\"`</li><li>`\"exchange_coinbase_us\"`</li><li>`\"exchange_okx\"`</li><li>`\"exchange_kraken\"`</li><li>`\"ripple_mainnet\"`</li><li>`\"solana_mainnet\"`</li><li>`\"solana_devnet\"`</li><li>`\"solana_eclipse_mainnet\"`</li><li>`\"solana_fogo_mainnet\"`</li><li>`\"solana_fogo_testnet\"`</li><li>`\"stacks_mainnet\"`</li><li>`\"starknet_mainnet\"`</li><li>`\"stellar_mainnet\"`</li><li>`\"sui_mainnet\"`</li><li>`\"sui_testnet\"`</li><li>`\"ton_mainnet\"`</li><li>`\"tron_mainnet\"`</li><li>`\"tron_shasta\"`</li><li>`\"bitcoin_mainnet\"`</li><li>`\"bitcoin_testnet\"`</li><li>`\"bitcoin_testnet_v4\"`</li><li>`\"dogecoin_mainnet\"`</li><li>`\"bitcoin_cash_mainnet\"`</li><li>`\"pearl_testnet\"`</li><li>`\"pearl_mainnet\"`</li><li>`\"evm_1\"`</li><li>`\"evm_5\"`</li><li>`\"evm_10\"`</li><li>`\"evm_14\"`</li><li>`\"evm_16\"`</li><li>`\"evm_30\"`</li><li>`\"evm_56\"`</li><li>`\"evm_100\"`</li><li>`\"evm_130\"`</li><li>`\"evm_137\"`</li><li>`\"evm_143\"`</li><li>`\"evm_146\"`</li><li>`\"evm_169\"`</li><li>`\"evm_196\"`</li><li>`\"evm_250\"`</li><li>`\"evm_324\"`</li><li>`\"evm_999\"`</li><li>`\"evm_1030\"`</li><li>`\"evm_1100\"`</li><li>`\"evm_1101\"`</li><li>`\"evm_1329\"`</li><li>`\"evm_1337\"`</li><li>`\"evm_1666\"`</li><li>`\"evm_1672\"`</li><li>`\"evm_1729\"`</li><li>`\"evm_2222\"`</li><li>`\"evm_4200\"`</li><li>`\"evm_4217\"`</li><li>`\"evm_4663\"`</li><li>`\"evm_5000\"`</li><li>`\"evm_7000\"`</li><li>`\"evm_7700\"`</li><li>`\"evm_8453\"`</li><li>`\"evm_8818\"`</li><li>`\"evm_8819\"`</li><li>`\"evm_9745\"`</li><li>`\"evm_16661\"`</li><li>`\"evm_17000\"`</li><li>`\"evm_80001\"`</li><li>`\"evm_80094\"`</li><li>`\"evm_42161\"`</li><li>`\"evm_43113\"`</li><li>`\"evm_43114\"`</li><li>`\"evm_57073\"`</li><li>`\"evm_59144\"`</li><li>`\"evm_81457\"`</li><li>`\"evm_421614\"`</li><li>`\"evm_534352\"`</li><li>`\"evm_660279\"`</li><li>`\"evm_747474\"`</li><li>`\"evm_810180\"`</li><li>`\"evm_11155111\"`</li><li>`\"evm_ethereum_mainnet\"`</li><li>`\"evm_ethereum_goerli\"`</li><li>`\"evm_optimism_mainnet\"`</li><li>`\"evm_flare_mainnet\"`</li><li>`\"evm_flare_testnet\"`</li><li>`\"evm_rootstock_mainnet\"`</li><li>`\"evm_bsc_mainnet\"`</li><li>`\"evm_gnosis_mainnet\"`</li><li>`\"evm_unichain_mainnet\"`</li><li>`\"evm_polygon_mainnet\"`</li><li>`\"evm_monad_mainnet\"`</li><li>`\"evm_sonic_mainnet\"`</li><li>`\"evm_manta_pacific_mainnet\"`</li><li>`\"evm_x_layer_mainnet\"`</li><li>`\"evm_fantom_mainnet\"`</li><li>`\"evm_zksync_era_mainnet\"`</li><li>`\"evm_hyperevm_mainnet\"`</li><li>`\"evm_conflux_mainnet\"`</li><li>`\"evm_dymension_mainnet\"`</li><li>`\"evm_polygon_zkevm_mainnet\"`</li><li>`\"evm_sei_mainnet\"`</li><li>`\"evm_hypercore_mainnet\"`</li><li>`\"evm_aster_mainnet\"`</li><li>`\"evm_pharos_mainnet\"`</li><li>`\"evm_reya_mainnet\"`</li><li>`\"evm_kava_mainnet\"`</li><li>`\"evm_merlin_mainnet\"`</li><li>`\"evm_tempo_mainnet\"`</li><li>`\"evm_robinhood_mainnet\"`</li><li>`\"evm_mantle_mainnet\"`</li><li>`\"evm_zeta_mainnet\"`</li><li>`\"evm_canto_mainnet\"`</li><li>`\"evm_base_mainnet\"`</li><li>`\"evm_clink_mainnet\"`</li><li>`\"evm_clink_testnet\"`</li><li>`\"evm_plasma_mainnet\"`</li><li>`\"evm_zero_gravity_mainnet\"`</li><li>`\"evm_ethereum_holesky\"`</li><li>`\"evm_polygon_mumbai\"`</li><li>`\"evm_berachain_mainnet\"`</li><li>`\"evm_arbitrum_mainnet\"`</li><li>`\"evm_avalanche_fuji\"`</li><li>`\"evm_avalanche_chain\"`</li><li>`\"evm_ink_mainnet\"`</li><li>`\"evm_linea_mainnet\"`</li><li>`\"evm_blast_mainnet\"`</li><li>`\"evm_arbitrum_sepolia\"`</li><li>`\"evm_scroll_mainnet\"`</li><li>`\"evm_xai_mainnet\"`</li><li>`\"evm_katana_mainnet\"`</li><li>`\"evm_zklink_nova_mainnet\"`</li><li>`\"evm_ethereum_sepolia\"`</li></ul>","title":"ChainUniqueId"}},"description":"List of chain IDs to fetch native assets for. Only vaults with positive native balance in any of these chains will be included in native_assets response."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVaultsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"401":{"description":"Unauthorized User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"403":{"description":"Forbidden User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"429":{"description":"Rate Limit Exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}}}},"post":{"tags":["Vaults"],"summary":"Create Vault","description":"Create a new vault.","operationId":"create_vault_api_v1_vaults_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVaultRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVaultResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefinedPreconditionError_CreateVaultErrorType_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/compone
# --- truncated at 32 KB (1359 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fordefi/refs/heads/main/openapi/fordefi-openapi-original.json