> ## Documentation Index
> Fetch the complete documentation index at: https://docs.portfobit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get synchronization status

> Requires `account:read`.



## OpenAPI

````yaml /openapi/portfobit-openapi.yaml get /syncs/{sync_id}
openapi: 3.1.0
info:
  title: Portfobit Open API
  version: 0.1.0
  description: >
    Public REST API for direct API clients, CI, scripts, service accounts,
    third-party agents, and developer integrations.

    Public REST requests use scoped Portfobit Open API keys. OAuth access tokens
    issued for the Portfobit MCP resource are not accepted by `/api/v1/*`
    endpoints.

    Portfobit is crypto-CEX-only. Financial values are decimal strings and
    timestamps are RFC 3339 UTC strings.

    The API never supports withdrawals, external-address transfers,
    cross-exchange transfers, or P2P transfers.
servers:
  - url: https://api.portfobit.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Context
  - name: Accounts
  - name: Portfolios
  - name: Valuation
  - name: Activity
  - name: Trading
  - name: Market data
  - name: Support
paths:
  /syncs/{sync_id}:
    get:
      tags:
        - Accounts
      summary: Get synchronization status
      description: Requires `account:read`.
      operationId: getSync
      parameters:
        - $ref: '#/components/parameters/SyncId'
      responses:
        '200':
          $ref: '#/components/responses/SyncResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    SyncId:
      name: sync_id
      in: path
      required: true
      schema:
        type: string
  responses:
    SyncResponse:
      description: Sync response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SyncResponseSchema'
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    SyncResponseSchema:
      type: object
      required:
        - data
        - message
        - meta
      properties:
        data:
          type: object
          required:
            - id
            - account_id
            - trigger_type
            - status
            - started_at
            - finished_at
            - balance_count
            - position_count
            - order_count
            - trade_count
            - ledger_entry_count
            - transaction_count
            - error_code
            - error_message
          properties:
            id:
              type: string
            account_id:
              type: string
            trigger_type:
              type: string
            status:
              type: string
            started_at:
              type: string
              format: date-time
            finished_at:
              type: string
              format: date-time
            balance_count:
              type: integer
            position_count:
              type: integer
            order_count:
              type: integer
            trade_count:
              type: integer
            ledger_entry_count:
              type: integer
            transaction_count:
              type: integer
            error_code:
              type:
                - string
                - 'null'
            error_message:
              type:
                - string
                - 'null'
        message:
          type: string
        meta:
          type: object
          required:
            - request_id
            - generated_at
          properties:
            request_id:
              type: string
            generated_at:
              type: string
              format: date-time
      example:
        data:
          id: sync_01J2K8NN5T
          account_id: acc_01H8XFK9A
          trigger_type: manual
          status: succeeded
          started_at: '2026-08-07T08:00:00Z'
          finished_at: '2026-08-07T08:00:03Z'
          balance_count: 4
          position_count: 1
          order_count: 2
          trade_count: 3
          ledger_entry_count: 5
          transaction_count: 1
          error_code: null
          error_message: null
        message: Account_sync_completed
        meta:
          request_id: req_01J2K8B7QW
          generated_at: '2026-08-07T08:00:03Z'
    ErrorEnvelope:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          $ref: '#/components/schemas/Error'
        meta:
          $ref: '#/components/schemas/Meta'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
    Meta:
      type: object
      required:
        - request_id
        - generated_at
      properties:
        request_id:
          type: string
        generated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Portfobit Open API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.