openapi: 3.1.0
info:
  title: Safe Transaction Service 4337 tokens API
  version: 6.3.0
  description: API to keep track of transactions sent via Safe smart contracts
tags:
- name: tokens
paths:
  /tx-service/eth/api/v1/tokens/:
    get:
      operationId: tokens_list
      description: Returns the list of tokens supported in the Safe Transaction Service
      parameters:
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: address
        schema:
          type: string
      - in: query
        name: symbol
        schema:
          type: string
      - in: query
        name: decimals__lt
        schema:
          type: integer
      - in: query
        name: decimals__gt
        schema:
          type: integer
      - in: query
        name: decimals
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      tags:
      - tokens
      security:
      - cookieAuth: []
      - tokenAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTokenInfoResponseList'
          description: ''
      path: /tx-service/eth/api/v1/tokens/
      title: List Tokens
      additionalInfo: ''
  /tx-service/eth/api/v1/tokens/{address}/:
    get:
      operationId: tokens_retrieve
      description: Returns detailed information on a given token supported in the Safe Transaction Service
      parameters:
      - in: path
        name: address
        schema:
          type: string
        required: true
      tags:
      - tokens
      security:
      - cookieAuth: []
      - tokenAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenInfoResponse'
          description: ''
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeErrorResponse'
          description: Invalid ethereum address
      path: /tx-service/eth/api/v1/tokens/{address}/
      title: Get a Specific Token's Information
      additionalInfo: ''
  /tx-service/eth/api/v1/tokens/lists/:
    get:
      operationId: tokens_lists_list
      description: Returns the list of tokens supported in the Safe Transaction Service
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      tags:
      - tokens
      security:
      - cookieAuth: []
      - tokenAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTokenListList'
          description: ''
      path: /tx-service/eth/api/v1/tokens/lists/
      title: List Token Data Sources
      additionalInfo: ''
components:
  schemas:
    PaginatedTokenInfoResponseList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/TokenInfoResponse'
    CodeErrorResponse:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        arguments:
          type: array
          items: {}
      required:
      - arguments
      - code
      - message
    TokenInfoResponse:
      type: object
      properties:
        type:
          type: string
          readOnly: true
        address:
          type: string
        name:
          type: string
        symbol:
          type: string
        decimals:
          type: integer
        logoUri:
          type: string
          readOnly: true
        trusted:
          type: boolean
      required:
      - address
      - decimals
      - logoUri
      - name
      - symbol
      - trusted
      - type
    TokenList:
      type: object
      properties:
        url:
          type: string
          format: uri
          maxLength: 200
        description:
          type: string
          maxLength: 200
      required:
      - description
      - url
    PaginatedTokenListList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/TokenList'
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"