bitcain docs
API Reference

Sync

Data synchronization and import/export operations

Get Sync Status

GET
/api/sync/status

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Response Body

application/json

curl -X GET "https://loading/api/sync/status"
{}

Start Sync

POST
/api/sync/start

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Request Body

application/json

sources?array<>|

Specific sources to sync (optional, syncs all if not provided)

full_sync?boolean

Perform full sync instead of incremental

Defaultfalse

Response Body

application/json

application/json

curl -X POST "https://loading/api/sync/start" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Stop Sync

POST
/api/sync/stop

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Response Body

application/json

curl -X POST "https://loading/api/sync/stop"
{}

Get Sync History

GET
/api/sync/history

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Query Parameters

page?integer

Page number

Default1
Range1 <= value
per_page?integer

Items per page

Default50
Range1 <= value <= 100

Response Body

application/json

application/json

curl -X GET "https://loading/api/sync/history"
{}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Manual Sync Trigger

POST
/api/sync/manual

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Request Body

application/json

source*string

Data source to sync

options?

Additional sync options

Response Body

application/json

application/json

curl -X POST "https://loading/api/sync/manual" \  -H "Content-Type: application/json" \  -d '{    "source": "string"  }'
{}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}