Skip to content

Latest commit

 

History

History
171 lines (98 loc) · 7.7 KB

WalletsApi.md

File metadata and controls

171 lines (98 loc) · 7.7 KB

\WalletsApi

All URIs are relative to https://api-sandbox.circle.com

Method HTTP request Description
create_wallet POST /v1/wallets Create a wallet
generate_address POST /v1/wallets/{walletId}/addresses Create a blockchain address
get_wallet GET /v1/wallets/{walletId} Get a wallet
list_addresses GET /v1/wallets/{walletId}/addresses List all addresses
list_wallets GET /v1/wallets List all wallets

create_wallet

models::CreateWalletResponse create_wallet(wallet_creation_request) Create a wallet

Creates an end user wallet.

Parameters

Name Type Description Required Notes
wallet_creation_request Option<WalletCreationRequest>

Return type

models::CreateWalletResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generate_address

models::GenerateAddressResponse generate_address(wallet_id, generate_address_request) Create a blockchain address

Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit.

Parameters

Name Type Description Required Notes
wallet_id String Identifier for the wallet. [required]
generate_address_request Option<GenerateAddressRequest>

Return type

models::GenerateAddressResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_wallet

models::GetWalletResponse get_wallet(wallet_id) Get a wallet

Parameters

Name Type Description Required Notes
wallet_id String Identifier for the wallet. [required]

Return type

models::GetWalletResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_addresses

models::ListAddressesResponse list_addresses(wallet_id, from, to, page_before, page_after, page_size) List all addresses

Retrieves a list of addresses associated with a wallet.

Parameters

Name Type Description Required Notes
wallet_id String Identifier for the wallet. [required]
from Option<String> Queries items created since the specified date-time (inclusive).
to Option<String> Queries items created before the specified date-time (inclusive).
page_before Option<String> A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjuction with pageAfter.
page_after Option<String> A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjuction with pageBefore.
page_size Option<i32> Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.

Return type

models::ListAddressesResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_wallets

models::ListWalletsResponse list_wallets(from, to, page_before, page_after, page_size) List all wallets

Retrieves a list of a user's wallets.

Parameters

Name Type Description Required Notes
from Option<String> Queries items created since the specified date-time (inclusive).
to Option<String> Queries items created before the specified date-time (inclusive).
page_before Option<String> A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjuction with pageAfter.
page_after Option<String> A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjuction with pageBefore.
page_size Option<i32> Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.

Return type

models::ListWalletsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]