v2 .2024-12-12
Jump to
Ctrl
+
/

Sync Address

POST
/addresses-historical/manage/{blockchain}/{network}

Through this endpoint, users can synchronize a specific address with Crypto APIs. Once the synchronization is complete, users will have access to the full historical data associated with the address.

Path Parameters

blockchain string Required
network string Required

Query Parameters

context string Optional

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.

Request Body Schema application/json

context string Optional

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.

data object Required
item object Required
address string Required
callbackUrl string Optional

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2024-12-12
requestId string Required

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

601c1710034ed6d407996b30
context string Optional

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.

yourExampleString
data object Required
item object Required
address string Required
0x3d0b25fe09e2cd92f06ba776391a122519936e90
blockchain string Required
ethereum
callcackUrl string Required
https://example.com
isActive boolean Optional
true
network string Required
sepolia
syncStatus string Required
completed

Callback parameters

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2024-12-12
referenceId string Required

Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.

6038d09050653d1f0e40584c
idempotencyKey string Required

Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.

e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c
data object Required

Specifies all data, as attributes, included into the callback notification, which depends on the event.

product string Required

Represents the Crypto APIs 2.0 product which sends the callback.

ADDRESS_HISTORY
event string Required

Defines the specific event, for which a callback subscription is set.

ADDRESS_SYNC_STATUS
item object Required

Defines an item as one result.

blockchain string Required

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

ethereum
network string Required

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", "goerli", "mumbai" are test networks.

sepolia
address string Required

Represents the address that is syncing

0x3d0b25fe09e2cd92f06ba776391a122519936e90
status string Required

Defines the sync status - "syncing" for process in proggress and "synced" for finished proccess.

synced

Credits Cost : 400 Credits for 1 Results

Was this page helpful?
Yes
No
Powered by
Language
URL

{
    "apiVersion": "2024-12-12",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "address": "0x3d0b25fe09e2cd92f06ba776391a122519936e90",
            "blockchain": "ethereum",
            "callcackUrl": "https://example.com",
            "isActive": true,
            "network": "sepolia",
            "syncStatus": "completed"
        }
    }
}
{
    "apiVersion": "2024-12-12",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "ADDRESS_HISTORY",
        "event": "ADDRESS_SYNC_STATUS",
        "item": {
            "blockchain": "ethereum",
            "network": "sepolia",
            "address": "0x3d0b25fe09e2cd92f06ba776391a122519936e90",
            "status": "synced"
        }
    }
}