List Synced Addresses

Through this endpoint users can list all addresses that Crypto APIs has synced for a specific xPub. This includes previous and current/new xPubs, what addresses we’ve synced for them, etc.

List of Results - This endpoint returns multiple objects which means pagination is applicable. GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/synced-addresses

Path Parameters

  • Required
    blockchain string

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

    Example : ethereum
    Possible Values : bitcoin ethereum
  • Required
    extendedPublicKey string

    Defines the account extended publicly known key which is used to derive all child public keys.

    Example : tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w
  • Required
    network string

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.

    Example : ropsten
    Possible Values : mainnet testnet ropsten

Query parameters

  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

    Example : yourExampleString
  • Optional
    addressFormat string

    Defines the address format value.

    Example : standard
    Possible Values : p2pkh p2sh p2wpkh p2pkh-cash p2sh-cash standard classic
  • Optional
    isChangeAddress boolean

    Defines if the address is change addres or not.

    Default : True
    Example : False
  • Optional
    limit integer

    Defines how many items should be returned in the response per page basis.

    Default : 50
    Example : 50
  • Optional
    offset integer

    The starting index of the response items, i.e. where the response should start listing the returned items.

    Default : 0
    Example : 0

Response schema

200 400 401 402 403 409 415 422 429 500
HTTP Status Code: 200
Content-Type: application/json

The request has been successful.

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2021-03-20
  • Required
    requestId string

    Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

    Example : 601c1710034ed6d407996b30
  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

    Example : yourExampleString
  • Required
    data object
    • Required
      limit integer

      Defines how many items should be returned in the response per page basis.

      Example : 50
    • Required
      offset integer

      The starting index of the response items, i.e. where the response should start listing the returned items.

      Example : 0
    • Required
      total integer

      Defines the total number of items returned in the response.

      Example : 100
    • Required
      items array
      Example : Array ( )
      • Required
        address string

        Represents the address.

        Example : 0x9e91eb3a35b96f0f0fe71f3c17fe8d29eb406b16
      • Required
        index integer

        Represents the index position of the transaction in the specific block.

        Example : 1

Credits Cost : 1 Credits For 1 Result(s)

Try it out

Request Example

GET
https://rest.cryptoapis.io/blockchain-data/ethereum/ropsten/hd/tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w/synced-addresses?context=yourExampleString&addressFormat=standard&isChangeAddress=0&limit=50&offset=0
Headers
Content-Type: application/json
X-API-Key: my-api-key

Response Example

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 100,
        "items": [
            {
                "address": "0x9e91eb3a35b96f0f0fe71f3c17fe8d29eb406b16",
                "index": 1
            }
        ]
    }
}