openapi: 3.1.0
info:
  title: Safe Transaction Service 4337 about API
  version: 6.3.0
  description: API to keep track of transactions sent via Safe smart contracts
tags:
- name: about
paths:
  /tx-service/eth/api/v1/about/:
    get:
      operationId: about_retrieve
      description: Returns information and configuration of the service
      tags:
      - about
      security:
      - cookieAuth: []
      - tokenAuth: []
      - {}
      responses:
        '200':
          description: No response body
      path: /tx-service/eth/api/v1/about/
      title: General Information
      additionalInfo: ''
  /tx-service/eth/api/v1/about/deployments/:
    get:
      operationId: about_deployments_list
      description: Returns a list of safe deployments by version
      parameters:
      - in: query
        name: version
        schema:
          type: string
        description: Filter by Safe version
      - in: query
        name: contract
        schema:
          type: string
        description: Filter by Safe contract name
      tags:
      - about
      security:
      - cookieAuth: []
      - tokenAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SafeDeployment'
          description: ''
        '404':
          description: Provided version does not exist
      path: /tx-service/eth/api/v1/about/deployments/
      title: List deployments
      additionalInfo: ''
  /tx-service/eth/api/v1/about/ethereum-rpc/:
    get:
      operationId: about_ethereum_rpc_retrieve
      description: Get information about the Ethereum RPC node used by the service
      tags:
      - about
      security:
      - cookieAuth: []
      - tokenAuth: []
      - {}
      responses:
        '200':
          description: No response body
      path: /tx-service/eth/api/v1/about/ethereum-rpc/
      title: Ethereum RPC
      additionalInfo: This is an example of more detailed information about Ethereum RPC endpoint. This should support MDX.
  /tx-service/eth/api/v1/about/ethereum-tracing-rpc/:
    get:
      operationId: about_ethereum_tracing_rpc_retrieve
      description: Get information about the Ethereum Tracing RPC node used by the service (if any configured)
      tags:
      - about
      security:
      - cookieAuth: []
      - tokenAuth: []
      - {}
      responses:
        '200':
          description: No response body
      path: /tx-service/eth/api/v1/about/ethereum-tracing-rpc/
      title: Ethereum Tracing RPC
      additionalInfo: ''
  /tx-service/eth/api/v1/about/indexing/:
    get:
      operationId: about_indexing_retrieve
      description: Get current indexing status for ERC20/721 events
      tags:
      - about
      security:
      - cookieAuth: []
      - tokenAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexingStatus'
          description: ''
      path: /tx-service/eth/api/v1/about/indexing/
      title: Indexing
      additionalInfo: ''
  /tx-service/eth/api/v1/about/singletons/:
    get:
      operationId: about_singletons_list
      description: Returns a list of Master Copies configured in the service
      tags:
      - about
      security:
      - cookieAuth: []
      - tokenAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MasterCopyResponse'
          description: ''
      path: /tx-service/eth/api/v1/about/singletons/
      title: Singletons
      additionalInfo: ''
components:
  schemas:
    MasterCopyResponse:
      type: object
      properties:
        address:
          type: string
        version:
          type: string
        deployer:
          type: string
        deployedBlockNumber:
          type: integer
        lastIndexedBlockNumber:
          type: integer
        l2:
          type: boolean
      required:
      - address
      - deployedBlockNumber
      - deployer
      - l2
      - lastIndexedBlockNumber
      - version
    SafeDeploymentContract:
      type: object
      properties:
        contractName:
          type: string
        address:
          type:
          - string
          - 'null'
      required:
      - address
      - contractName
    SafeDeployment:
      type: object
      properties:
        version:
          type: string
          maxLength: 10
        contracts:
          type: array
          items:
            $ref: '#/components/schemas/SafeDeploymentContract'
      required:
      - contracts
      - version
    IndexingStatus:
      type: object
      properties:
        currentBlockNumber:
          type: integer
        currentBlockTimestamp:
          type: string
          format: date-time
        erc20BlockNumber:
          type: integer
        erc20BlockTimestamp:
          type: string
          format: date-time
        erc20Synced:
          type: boolean
        masterCopiesBlockNumber:
          type: integer
        masterCopiesBlockTimestamp:
          type: string
          format: date-time
        masterCopiesSynced:
          type: boolean
        synced:
          type: boolean
      required:
      - currentBlockNumber
      - currentBlockTimestamp
      - erc20BlockNumber
      - erc20BlockTimestamp
      - erc20Synced
      - masterCopiesBlockNumber
      - masterCopiesBlockTimestamp
      - masterCopiesSynced
      - synced
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"