POST
/
#particle_aa_getBTCAccount

​
Understanding getBTCAccount

  • getBTCAccountcalculates and return the information of smart account tied to an account address from btc public key. It takes:
    Account config object:
    • name- string. only BTC
    • version - string. Either 1.0.0 or 2.0.0.
    • btcPublicKey - string.
    • btcAddress - string. optional

​
Query example

Authorizations

​
Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Defines the structure for BTC account request data.

​
jsonrpc
string
default: 2.0required

JSON-RPC protocol version, should be 2.0.

​
id
integer
default: 1required

Identifier for the request.

​
method
string
default: particle_aa_getBTCAccountrequired

The method to be invoked on the RPC server.

​
params
object[]
required

Array containing parameters for the method.

Response

200 - application/json

Response schema for getBTCAccount.

​
jsonrpc
string

JSON-RPC protocol version used in the response.

​
id
integer

Identifier matching the request.

​
result
object

Contains the smart account information derived from the BTC public key.

Was this page helpful?

Web (JS/TS) - BTC ConnectgetBTCAccountsByAddress