swagger.yaml

openapi: 3.0.0
info:
    title: DB Sync API
    version: 1.0.0
    description: APIs for cardano DB Sync

paths:
    /api/stake-address:
        get:
            summary: Retrieve stake address information
            description: Get the latest stake registration and deregistration for a given stake address.
            tags:
                - Stake
            parameters:
                - name: address
                  in: query
                  required: true
                  description: The stake address in hexadecimal or Bech32 format.
                  schema:
                      type: string
            responses:
                '200':
                    description: Successful response with stake address data.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    registration:
                                        type: object
                                        nullable: true
                                        properties:
                                            epoch_no:
                                                type: integer
                                                description: Epoch number.
                                            slot_no:
                                                type: integer
                                                description: Slot number.
                                            block_no:
                                                type: integer
                                                description: Slot Number.
                                            time:
                                                type: string
                                                description: Time of transaction.
                                            tx_hash:
                                                type: string
                                                description: Transaction hash.
                                    deregistration:
                                        type: object
                                        nullable: true
                                        properties:
                                            epoch_no:
                                                type: integer
                                                description: Epoch number.
                                            slot_no:
                                                type: integer
                                                description: Slot number.
                                            block_no:
                                                type: integer
                                                description: Slot Number.
                                            time:
                                                type: string
                                                description: Time of transaction.
                                            tx_hash:
                                                type: string
                                                description: Transaction hash.
                '400':
                    description: Bad Request. The request is missing required parameters or has invalid data.
                '404':
                    description: Not Found. The stake address does not exist in the database.
                '500':
                    description: Internal Server Error. An unexpected error occurred while processing the request.

    /api/delegation:
        get:
            summary: Get latest delegation information
            description: Fetches the latest delegation and pool delegation details for the given address.
            tags:
                - Stake
            operationId: getDelegation
            parameters:
                - name: address
                  in: query
                  required: true
                  description: Bech32 or hex-encoded address to query.
                  schema:
                      type: string
                      example: 'stake_test1ur34vgj0kk338wlfsdf7fnxs9uukh24047lc2wfmm0mgptgq7849c'
            responses:
                '200':
                    description: Successful response with delegation and pool information.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    drep:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                drep_id:
                                                    type: string
                                                    description: The view of the DRep.
                                                epoch_no:
                                                    type: integer
                                                    description: The epoch number of the delegation.
                                                slot_no:
                                                    type: integer
                                                    description: The slot number of the delegation.
                                                block_no:
                                                    type: integer
                                                    description: The block number.
                                                time:
                                                    type: string
                                                    format: date-time
                                                    description: The time of the block.
                                                tx_hash:
                                                    type: string
                                                    description: The transaction hash.
                                    pool:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                pool_id:
                                                    type: string
                                                    description: The view of the pool.
                                                epoch_no:
                                                    type: integer
                                                    description: The epoch number of the delegation.
                                                slot_no:
                                                    type: integer
                                                    description: The slot number.
                                                block_no:
                                                    type: integer
                                                    description: The block number.
                                                time:
                                                    type: string
                                                    format: date-time
                                                    description: The time of the block.
                                                tx_hash:
                                                    type: string
                                                    description: The transaction hash.

                '400':
                    description: Bad request. The `address` query parameter is missing or invalid.
                '500':
                    description: Internal server error.
    /api/drep/{id}/live-delegators:
        get:
            summary: Get live delegators for a DRep
            description: Fetch the list of live delegators associated with the specified DRep ID.
            tags:
                - DRep Delegation
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The DRep ID in hex or Bech32 format.
                  schema:
                      type: string
                      example: 'drep15fy2nszna039pdregpryhzahnwcr2rred4nx2qaec7k07nvcq26'
                - in: query
                  name: page
                  schema:
                      type: number
                      default: 1
                  required: false
                - in: query
                  name: size
                  schema:
                      type: number
                      default: 10
                  required: false
                - name: balance
                  in: query
                  required: false
                  description: The live balance of the delegator.
                  schema:
                      type: boolean
                      example: false
            responses:
                '200':
                    description: A list of active delegators.
                    content:
                    application/json:
                        schema:
                            type: array
                            items:
                                type: object
                                properties:
                                    delegatorStake:
                                        type: string
                                        description: The stake address of the delegator.
                                    balance:
                                        type: object
                                        properties:
                                            utxoBalance:
                                                type: string
                                                description: The UTXO balance of the delegator.
                                            rewardBalance:
                                                type: string
                                                description: The reward balance of the delegator.
                                            rewardRestBalance:
                                                type: string
                                                description: The reward rest balance of the delegator.
                                    delegatedAt:
                                        type: object
                                        properties:
                                            txId:
                                                type: string
                                                description: The transaction ID of the delegation.
                                            epochNo:
                                                type: integer
                                                description: The epoch number of the delegation.
                                            time:
                                                type: string
                                                format: date-time
                                                description: The time of the delegation.
                '400':
                    description: Invalid DRep ID.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                message:
                                    type: string
                                    example: Provide a valid Drep ID
                '500':
                    description: Internal server error.
    /api/drep/{id}/active-delegators:
        get:
            summary: Get active delegators for a DRep
            description: Fetch the list of active delegators associated with the specified DRep ID.
            tags:
                - DRep Delegation
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The DRep ID in hex or Bech32 format.
                  schema:
                      type: string
                      example: 'drep15fy2nszna039pdregpryhzahnwcr2rred4nx2qaec7k07nvcq26'
                - in: query
                  name: page
                  schema:
                      type: number
                      default: 1
                  required: false
                - in: query
                  name: size
                  schema:
                      type: number
                      default: 10
                  required: false
                - name: balance
                  in: query
                  required: false
                  description: The active balance of the delegator.
                  schema:
                      type: boolean
                      example: false
            responses:
                '200':
                    description: A list of active delegators.
                    content:
                    application/json:
                        schema:
                            type: array
                            items:
                                type: object
                                properties:
                                    delegatorStake:
                                        type: string
                                        description: The stake address of the delegator.
                                    balance:
                                        type: object
                                        properties:
                                            utxoBalance:
                                                type: string
                                                description: The UTXO balance of the delegator.
                                            rewardBalance:
                                                type: string
                                                description: The reward balance of the delegator.
                                            rewardRestBalance:
                                                type: string
                                                description: The reward rest balance of the delegator.
                                    delegatedAt:
                                        type: object
                                        properties:
                                            txId:
                                                type: string
                                                description: The transaction ID of the delegation.
                                            epochNo:
                                                type: integer
                                                description: The epoch number of the delegation.
                                            time:
                                                type: string
                                                format: date-time
                                                description: The time of the delegation.
                '400':
                    description: Invalid DRep ID.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                message:
                                    type: string
                                    example: Provide a valid Drep ID
                '500':
                    description: Internal server error.
    /api/drep/{id}/stats/live:
        get:
            summary: Fetch live delegation stats for a Drep
            description: Retrieves live delegation stats for a given Drep ID.
            tags:
                - DRep Delegation
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The Drep ID (either in hexadecimal or Bech32 format).
                  schema:
                      type: string
                      example: 'drep15fy2nszna039pdregpryhzahnwcr2rred4nx2qaec7k07nvcq26'
            responses:
                '200':
                    description: Successfully fetched active delegation data
                    content:
                    application/json:
                        schema:
                        type: object
                        properties:
                            liveDelegators:
                                type: integer
                                example: 17
                            liveVotingPower:
                                type: string
                                example: '20027234084683'
                            influence:
                                type: string
                                example: '19.9043%'
                            voted:
                                type: integer
                                example: 17
                            notVoted:
                                type: integer
                                example: 300
                '400':
                    description: Bad Request - Invalid Drep ID
                    content:
                    application/json:
                        schema:
                        type: object
                        properties:
                            message:
                            type: string
                            example: 'Provide a valid Drep ID'
                '500':
                    description: Internal Server Error
                    content:
                    application/json:
                        schema:
                        type: object
                        properties:
                            message:
                            type: string
                            example: 'An unexpected error occurred'
    /api/drep/{id}:
        get:
            summary: Get DRep details
            description: Fetches DRep details including registration status, metadata, voting power, and transaction hashes for the provided address.
            tags:
                - DRep Information
            operationId: getDrepDetails
            parameters:
                - name: id
                  in: path
                  required: true
                  description: Hex-encoded address or Bech32 address of DRep .
                  schema:
                      type: string
                      example: 'drep15fy2nszna039pdregpryhzahnwcr2rred4nx2qaec7k07nvcq26'
            responses:
                '200':
                    description: Successful response with DRep and SoleVoter details.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    hasScript:
                                        type: boolean
                                        description: whether the drep has script or not
                                    isRegisteredAsDRep:
                                        type: boolean
                                        description: Whether the address is currently registered as a DRep.
                                    wasRegisteredAsDRep:
                                        type: boolean
                                        description: Whether the address was previously registered as a DRep.
                                    isRegisteredAsSoleVoter:
                                        type: boolean
                                        description: Whether the address is currently registered as a Sole Voter.
                                    wasRegisteredAsSoleVoter:
                                        type: boolean
                                        description: Whether the address was previously registered as a Sole Voter.
                                    deposit:
                                        type: integer
                                        description: The current deposit value.
                                    url:
                                        type: string
                                        description: The metadata URL.
                                    dataHash:
                                        type: string
                                        description: Hash of the metadata.
                                    votingPower:
                                        type: integer
                                        description: The current voting power.
                                    dRepRegisterTxHash:
                                        type: string
                                        description: Transaction hash for DRep registration.
                                    dRepRetireTxHash:
                                        type: string
                                        description: Transaction hash for DRep retirement.
                                    soleVoterRegisterTxHash:
                                        type: string
                                        description: Transaction hash for Sole Voter registration.
                                    soleVoterRetireTxHash:
                                        type: string
                                        description: Transaction hash for Sole Voter retirement.

                '400':
                    description: Bad Request. Address is invalid or missing.
                '500':
                    description: Internal Server Error. Something went wrong with the query or database.

    /api/drep/{id}/vote:
        get:
            summary: Get voting details by DRep ID
            description: Retrieve voting details for a specific DRep ID.
            tags:
                - DRep Information
            parameters:
                - name: id
                  in: path
                  required: true
                  description: Hex-encoded address or Bech32 address of DRep .
                  schema:
                      type: string
                      example: 'drep15fy2nszna039pdregpryhzahnwcr2rred4nx2qaec7k07nvcq26'
                - in: query
                  name: page
                  schema:
                      type: number
                      default: 1
                  required: false
                - in: query
                  name: size
                  schema:
                      type: number
                      default: 10
                  required: false
            responses:
                '200':
                    description: Successfully retrieved voting details of given Drep
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    govActionId:
                                        type: string
                                        description: Unique identifier for the government action, combining hash and index.
                                        example: '8af0c0c97f532ebd72df62cf798ac19fc2ec952d411ece7de89#0'
                                    title:
                                        type: string
                                        nullable: true
                                        description: Title of the government action.
                                        example: 'Example Title'
                                    voteType:
                                        type: string
                                        description: Type of vote.
                                        example: 'Abstain'
                                    voteAnchorUrl:
                                        type: string
                                        format: uri
                                        description: URL of the vote anchor.
                                        example: 'https://example.com/aMBitupUUJucUCAg9sxVyHe4jjk41dzst9J'
                                    voteAnchorHash:
                                        type: string
                                        description: Hash of the vote anchor data.
                                        example: 'd6086a79267ab5fb7b56c8ab77f1e0dff2c3'
                                    epochNo:
                                        type: integer
                                        description: Epoch number associated with the government action.
                                        example: 762
                                    time:
                                        type: string
                                        format: date-time
                                        description: Timestamp of the action.
                                        example: '2024-11-25T07:23:50'
                                    voteTxHash:
                                        type: string
                                        description: Transaction hash of the vote.
                                        example: '8d09be316ced784c1dd5bbcf7dccc0d63ea8de44b6e'
                                    govActionType:
                                        type: string
                                        description: Type of government action.
                                        example: 'NoConfidence'
                '404':
                    description: DRep ID not found
                '500':
                    description: Internal server error

    /api/drep/{id}/delegation:
        get:
            summary: Get delegation details by DRep ID
            description: Retrieve delegation details for a specific DRep ID.
            tags:
                - DRep Delegation
            parameters:
                - name: id
                  in: path
                  required: true
                  description: Hex-encoded address or Bech32 address of DRep.
                  schema:
                      type: string
                      example: 'drep15fy2nszna039pdregpryhzahnwcr2rred4nx2qaec7k07nvcq26'
                - in: query
                  name: page
                  schema:
                      type: number
                      default: 1
                  required: false
                - in: query
                  name: size
                  schema:
                      type: number
                      default: 10
                  required: false
            responses:
                '200':
                    description: A list of stake delegations.
                    content:
                        application/json:
                            schema:
                            type: array
                            items:
                                stakeAddress:
                                    type: string
                                    example: 'stake_test17pmm4fm6aahntj59y7p2xkmhkppp2yc3qlejgln997dcy4scqeut3'
                                action:
                                    type: string
                                    example: 'joined'
                                txId:
                                    type: string
                                    example: '08e5daeb18137efd8ad3ddbda6347f490a3efa8f839da3e2a18836ba0ff1bba8'
                                epochNo:
                                    type: integer
                                    example: 818
                                time:
                                    type: string
                                    example: '2025-01-20T08:35:02'
                '404':
                    description: DRep ID not found
                '500':
                    description: Internal server error

    /api/drep/{id}/registration:
        get:
            summary: Get registration details by DRep ID
            description: Retrieve registration details for a specific DRep ID.
            tags:
                - DRep Information
            parameters:
                - name: id
                  in: path
                  required: true
                  description: Hex-encoded address or Bech32 address of DRep .
                  schema:
                      type: string
                      example: 'drep15fy2nszna039pdregpryhzahnwcr2rred4nx2qaec7k07nvcq26'
                - in: query
                  name: page
                  schema:
                      type: number
                      default: 1
                  required: false
                - in: query
                  name: size
                  schema:
                      type: number
                      default: 10
                  required: false
            responses:
                '200':
                    description: Successfully retrieved voting details of given Drep
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    url:
                                        type: string
                                        example: 'https://xyz.com/drep-id/data/main/preview/test'
                                    deposit:
                                        type: integer
                                        nullable: true
                                        example: null
                                    drepName:
                                        type: string
                                        example: 'name'
                                    time:
                                        type: string
                                        format: date-time
                                        example: '2024-12-12T08:11:03.000Z'
                '404':
                    description: DRep ID not found
                '500':
                    description: Internal server error

    /api/address/balance:
        get:
            summary: Get faucet balance for a given address
            description: Retrieves the balance for a specified stake address.
            tags:
                - Address
            parameters:
                - in: query
                  name: address
                  schema:
                      type: string
                  required: true
                  description: The stake address in hex format to query the balance.
            responses:
                '200':
                    description: The faucet balance for the given address
                    content:
                        application/json:
                            schema:
                                type: integer
                                description: The balance in lovelace (smallest unit of ADA)
                                example: 1000000000
                '400':
                    description: Invalid address provided
                '500':
                    description: Internal server error
    /api/blockchain/epoch:
        get:
            summary: Get epoch number, start time, end time and duration
            description: Get epoch number, start time, end time and duration
            tags:
                - Blockchain
            parameters:
                - in: query
                  name: limit
                  schema:
                      type: string
                      default: 5
                  required: false
                  description: The information of the last 'n' epochs.
            responses:
                '200':
                    description: epoch details
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    type: object
                                    properties:
                                        epoch:
                                            type: integer
                                            description: Epoch number
                                            example: 836
                                        duration:
                                            type: string
                                            description: Epoch duration in milliseconds (as a string)
                                            example: '22170000'
                                        startTime:
                                            type: string
                                            format: date-time
                                            description: Start time in ISO 8601 format
                                            example: '2025-02-07T00:00:01.000Z'
                                        endTime:
                                            type: string
                                            format: date-time
                                            description: End time in ISO 8601 format
                                            example: '2025-02-07T06:09:31.000Z'
                '400':
                    description: Invalid address provided
                '500':
                    description: Internal server error
    /api/blockchain/block:
        get:
            summary: Get block details of a specific block number or get a list of details of latest 'n' blocks (default 5)
            description: Get block details of a specific block number or get a list of details of latest 'n' blocks (default 5)
            tags:
                - Blockchain
            parameters:
                - in: query
                  name: block_no
                  schema:
                      type: integer
                  required: false
                  description: specify block number to get the details of
                - in: query
                  name: limit
                  schema:
                      type: integer
                  required: false
                  description: number of latest block details
            responses:
                '200':
                    description: block details
                '500':
                    description: Internal server error
    /api/blockchain/epoch/params:
        get:
            summary: Get protocol parameters of specific epoch if specified. Else, get latest protocol parameters
            description: Get protocol parameters of specific epoch if specified. Else, get latest protocol parameters
            tags:
                - Blockchain
            parameters:
                - in: query
                  name: epoch_no
                  schema:
                      type: integer
                  required: false
                  description: get protocol parameters of specified epoch.
            responses:
                '200':
                    description: protocol parameters
                '400':
                    description: Invalid address provided
                '500':
                    description: Internal server error
    /api/blockchain/gov-state/committee:
        get:
            summary: Get Committee Gov-State
            description: Get details regarding committee members, quorum, their expiration and previous gov action id
            tags:
                - Blockchain
            responses:
                '200':
                    description: gov state
                '500':
                    description: Internal server error
    /api/drep:
        get:
            summary: Fetch DRep list
            description: Fetches the drep list.
            tags:
                - DRep Information
            parameters:
                - in: query
                  name: page
                  schema:
                      type: number
                      default: 1
                  required: false
                - in: query
                  name: sort
                  schema:
                      type: string
                      enum: [VotingPower, RegistrationDate]
                - in: query
                  name: status
                  schema:
                      type: string
                      enum: [Active, Inactive, Retired]
                - in: query
                  name: size
                  schema:
                      type: number
                      default: 10
                  required: false
                - in: query
                  name: search
                  description: Search by dRepId, dRepView or dRep Name
                  schema:
                      type: string
                      default: ''
                  required: false
            responses:
                200:
                    description: 'A paginated list of DRep details.'
                    content:
                        application/json:
                            schema:
                                type: 'object'
                                properties:
                                    items:
                                        type: 'array'
                                        items:
                                            type: 'object'
                                            properties:
                                                drepId:
                                                    type: 'string'
                                                    example: 'string'
                                                    description: 'DRep ID in hexadecimal format.'
                                                view:
                                                    type: 'string'
                                                    example: 'string'
                                                    description: "DRep's view identifier."
                                                url:
                                                    type: 'string'
                                                    format: 'uri'
                                                    example: 'string'
                                                    description: "URL to the DRep's metadata."
                                                metadataHash:
                                                    type: 'string'
                                                    example: 'string'
                                                    description: 'Hash of the metadata.'
                                                deposit:
                                                    type: 'integer'
                                                    format: 'int64'
                                                    example: 0
                                                    description: 'Deposit amount.'
                                                votingPower:
                                                    type: 'integer'
                                                    format: 'int64'
                                                    example: 0
                                                    description: "DRep's amount."
                                                active:
                                                    type: 'boolean'
                                                    example: false
                                                    description: 'Indicates if the DRep is active.'
                                                latestTxHash:
                                                    type: 'string'
                                                    example: 'string'
                                                    description: 'Hash of the latest transaction.'
                                                latestRegistrationDate:
                                                    type: 'string'
                                                    format: 'date-time'
                                                    example: '0000-00-00T00:00:00'
                                                    description: 'Date and time of the latest registration.'
                                    page:
                                        type: 'integer'
                                        example: 0
                                        description: 'Current page number.'
                                    size:
                                        type: 'integer'
                                        example: 0
                                        description: 'Number of items returned per page.'
                                    total:
                                        type: 'integer'
                                        example: 0
                                        description: 'Total number of items'
                '400':
                    description: Invalid address provided
                '500':
                    description: Internal server error
    /api/governance/live-stake:
        get:
            summary: Get Total Live Stake
            tags:
                - Governance
            responses:
                200:
                    description: Successfully retrieved total live stake
                    content:
                        application/json:
                            schema:
                                type: string
                                example: '1000000000000'
                500:
                    description: Internal server error
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                        example: 'Internal Server Error'
    /api/governance/active-stake:
        get:
            summary: Get Total Active Stake
            tags:
                - Governance
            responses:
                200:
                    description: Successfully retrieved total live stake
                    content:
                        application/json:
                            schema:
                                type: string
                                example: '1000000000000'
                500:
                    description: Internal server error
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                        example: 'Internal Server Error'
    /api/proposal:
        get:
            summary: Fetch Proposal list
            description: Fetches the Proposal list.
            tags:
                - Gov Action
            parameters:
                - in: query
                  name: vote_count
                  schema:
                      type: boolean
                      default: false
                  required: false
                - in: query
                  name: page
                  schema:
                      type: number
                      default: 1
                  required: false
                - in: query
                  name: size
                  schema:
                      type: number
                      default: 10
                  required: false
                - in: query
                  name: sort
                  schema:
                      type: string
                      enum: ['Newly Created', 'Soon to Expire', 'Highest Yes Count']
                - in: query
                  name: state
                  schema:
                      type: string
                      enum: ['Live', 'Expired', 'Ratified', 'Enacted', 'Dropped']
                - in: query
                  name: type
                  schema:
                      type: array
                      items:
                          type: string
                          enum:
                              - ParameterChange
                              - HardForkInitiation
                              - TreasuryWithdrawals
                              - NoConfidence
                              - NewCommittee
                              - NewConstitution
                              - InfoAction
                  description: Filter by one or more action types.
                  explode: true
                - in: query
                  name: proposal
                  description: Search by proposal id
                  schema:
                      type: string
                      default: ''
                  required: false
            responses:
                200:
                    description: 'A paginated list of Proposal details.'
                    content:
                        application/json:
                            schema:
                                type: 'object'
                                properties:
                                    items:
                                        type: 'array'
                                        items:
                                            type: 'object'
                                            properties:
                                                id:
                                                    type: integer
                                                    example: 418
                                                txHash:
                                                    type: string
                                                    example: ''
                                                index:
                                                    type: integer
                                                    example: 0
                                                type:
                                                    type: string
                                                    example: ''
                                                details:
                                                    type: object
                                                    additionalProperties: true
                                                    example: {}
                                                expiryDate:
                                                    type: string
                                                    format: date-time
                                                    example: '2024-10-08T07:25:57.226978'
                                                expiryEpochNon:
                                                    type: integer
                                                    example: 481
                                                createdDate:
                                                    type: string
                                                    format: date-time
                                                    example: '2024-09-23T10:35:09'
                                                createdEpochNo:
                                                    type: integer
                                                    example: 466
                                                url:
                                                    type: string
                                                    example: ''
                                                metadataHash:
                                                    type: string
                                                    example: '1111111111111111111111111111111111111111111111111111111111111111'
                                                protocolParams:
                                                    type: object
                                                    nullable: true
                                                title:
                                                    type: string
                                                    nullable: true
                                                abstract:
                                                    type: string
                                                    nullable: true
                                                motivation:
                                                    type: string
                                                    nullable: true
                                                rationale:
                                                    type: string
                                                    nullable: true
                                                dRepYesVotes:
                                                    type: integer
                                                    example: 0
                                                dRepNoVotes:
                                                    type: integer
                                                    example: ''
                                                dRepAbstainVotes:
                                                    type: integer
                                                    example: ''
                                                poolYesVotes:
                                                    type: integer
                                                    example: 0
                                                poolNoVotes:
                                                    type: integer
                                                    example: 0
                                                poolAbstainVotes:
                                                    type: integer
                                                    example: 0
                                                ccYesVotes:
                                                    type: integer
                                                    example: 0
                                                ccNoVotes:
                                                    type: integer
                                                    example: 0
                                                ccAbstainVotes:
                                                    type: integer
                                                    example: 0
                                                prevGovActionIndex:
                                                    type: integer
                                                    nullable: true
                                                prevGovActionTxHash:
                                                    type: string
                                                    nullable: true
                                    page:
                                        type: 'integer'
                                        example: 0
                                        description: 'Current page number.'
                                    size:
                                        type: 'integer'
                                        example: 0
                                        description: 'Number of items returned per page.'
                                    total:
                                        type: 'integer'
                                        example: 0
                                        description: 'Total number of items'
                '400':
                    description: Invalid address provided
                '500':
                    description: Internal server error
    /api/proposal/{id}:
        get:
            summary: Get the specific proposal details
            description: Returns Proposal details for a valid proposal id
            tags:
                - Gov Action
            parameters:
                - name: id
                  in: path
                  required: true
                  description: Proposal Id in hash#index format or bech32.
                  schema:
                      type: string
                      example: 'f72fb9e4438d7075d3ccd15d6c2ef743016125fef25a46ce63e48ac8bc29172c#0'
                - in: query
                  name: vote_count
                  schema:
                      type: boolean
                      default: false
                  required: false
            responses:
                '200':
                    description: Proposal details
                '400':
                    description: Invalid proposal id format
                '404':
                    description: Proposal not found
    /api/proposal/{id}/votes:
        get:
            summary: Get vote history for a specific proposal
            description: Returns history of votes with voter info and vote time. Optional parameter to include voting power.
            tags:
                - Gov Action
            parameters:
                - name: id
                  in: path
                  required: true
                  descripton: Proposal Id in hash#index format or bech32.
                  schema:
                      type: string
                      example: 'f72fb9e4438d7075d3ccd15d6c2ef743016125fef25a46ce63e48ac8bc29172c#0'
                - in: query
                  name: voting_power
                  schema:
                      type: boolean
                      default: false
                  required: false
            responses:
                '200':
                    description: Proposal voting history
                '400':
                    description: Invalid proposal id format
                '404':
                    description: Proposal not found
    /api/proposal/{id}/vote-count:
        get:
            summary: Get detailed vote count of a proposal
            description: Returns detials of votes (yes, no, abstain, noconfidence) from DReps, SPOs and CCs for a specific proposal Id
            tags:
                - Gov Action
            parameters:
                - name: id
                  in: path
                  required: true
                  descripton: Proposal Id in hash#index format or bech32.
                  schema:
                      type: string
                      example: 'f72fb9e4438d7075d3ccd15d6c2ef743016125fef25a46ce63e48ac8bc29172c#0'
            responses:
                '200':
                    description: Proposal vote count and voting power
                '400':
                    description: Invalid proposal id format
                '404':
                    description: Proposal not found
    /api/proposal/{id}/vote-count/{voter}:
        get:
            summary: Get detailed vote count of a sprcific type of voter on a proposal
            description: Returns detials of votes (yes, no, abstain, noconfidence) from DReps or SPOs or CCs
            tags:
                - Gov Action
            parameters:
                - name: id
                  in: path
                  required: true
                  descripton: Proposal Id in hash#index format or bech32.
                  schema:
                      type: string
                      example: 'f72fb9e4438d7075d3ccd15d6c2ef743016125fef25a46ce63e48ac8bc29172c#0'
                - name: voter
                  in: path
                  requires: false
                  description: Get count of specific type of voter. drep | spo | cc
                  schema:
                      type: string
                      enum:
                          - 'drep'
                          - 'spo'
                          - 'cc'
                      example: 'drep'
            responses:
                '200':
                    description: Proposal vote count and voting power
                '400':
                    description: Invalid proposal id format
                '404':
                    description: Proposal not found
    /api/gov-action/count:
        get:
            summary: Get the total number of government action proposals
            description: Returns the total number of records in the `gov_action_proposal` table.
            tags:
                - Gov Action
            responses:
                '200':
                    description: Total count retrieved successfully
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    totalGovActions:
                                        type: integer
                                        example: 42
                '500':
                    description: Server error while retrieving the total count
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                        example: 'An error occurred while counting records.'
    /api/gov-action:
        get:
            summary: Get government actions
            description: Fetch government actions related to a transaction hash or all actions if no hash is provided.
            tags:
                - Gov Action
            parameters:
                - name: id
                  in: query
                  description: Transaction hash (hex) to filter government actions. Optional.
                  required: false
                  schema:
                      type: string
                      example: 'fd3cd51b4307d82d58a7843f63b03335e08e5ab2ddbe3dd0464541a3bbcad488'
            responses:
                '200':
                    description: A list of government actions
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    type: object
                                    properties:
                                        govActionId:
                                            type: string
                                            description: The unique identifier for the government action, based on the transaction hash and action index.
                                            example: 'abc123#1'
                                        govActionType:
                                            type: string
                                            description: The type of the government action (e.g., ratified, enacted, dropped, etc.).
                                            example: 'ratified'
                                        history:
                                            type: object
                                            description: The history of the government action, including timestamps of various states.
                                            properties:
                                                ratifiedEpoch:
                                                    type: integer
                                                    description: The epoch when the action was ratified.
                                                    example: 100
                                                enactedEpoch:
                                                    type: integer
                                                    description: The epoch when the action was enacted.
                                                    example: 105
                                                droppedEpoch:
                                                    type: integer
                                                    description: The epoch when the action was dropped.
                                                    example: 110
                                                expiredEpoch:
                                                    type: integer
                                                    description: The epoch when the action expired.
                                                    example: 120
                                            nullable: true
                                example:
                                    - govActionId: 'abc123#1'
                                      govActionType: 'ratified'
                                      history:
                                          ratifiedEpoch: 100
                                    - govActionId: 'abc123#2'
                                      govActionType: 'enacted'
                                      history: {}
                '400':
                    description: Bad request, invalid input.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                        example: 'Invalid input'
                '404':
                    description: Transaction not found for the given hash.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                        example: 'Transaction not found'
                '500':
                    description: Internal server error.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                        example: 'Internal server error'
    /api/health:
        get:
            summary: Health check for DBSync
            description: Fetches the latest block information from the database and checks its freshness to determine the DBSync service's health.
            tags:
                - Health
            responses:
                '200':
                    description: Service is healthy, and the latest block is up-to-date.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    status:
                                        type: string
                                        example: 'Healthy'
                                    details:
                                        type: object
                                        properties:
                                            blockHash:
                                                type: string
                                                example: 'abcd1234ef5678...'
                                            blockNo:
                                                type: integer
                                                example: 123456
                                            slotNo:
                                                type: string
                                                example: '789012'
                                            blockTime:
                                                type: string
                                                format: date-time
                                                example: '2024-12-03T13:00:00Z'
                                            currentTime:
                                                type: string
                                                format: date-time
                                                example: '2024-12-03T13:05:00Z'
                                            secondsSinceLastUpdate:
                                                type: number
                                                example: 300
                '503':
                    description: The latest block has not been updated in over 300 seconds.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    status:
                                        type: string
                                        example: 'Service Unavailable'
                                    details:
                                        type: object
                                        properties:
                                            blockHash:
                                                type: string
                                                example: 'abcd1234ef5678...'
                                            blockNo:
                                                type: integer
                                                example: 123456
                                            slotNo:
                                                type: string
                                                example: '789012'
                                            blockTime:
                                                type: string
                                                format: date-time
                                                example: '2024-12-03T12:55:00Z'
                                            currentTime:
                                                type: string
                                                format: date-time
                                                example: '2024-12-03T13:05:00Z'
                                            secondsSinceLastUpdate:
                                                type: number
                                                example: 600
                '500':
                    description: An error occurred while processing the request.
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    message:
                                        type: string
                                        example: 'An error occurred while checking the DbSync status.'