openapi-3.0.0.yaml

openapi: 3.0.0
info:
  description: >-
    API documentation for TRTL Services - build on-chain apps in an easy, fun
    and fast way on the TRTL Network.
  version: 0.9.0
  title: TRTL.Services API
  termsOfService: 'https://trtl.services'
  license:
    name: 'AGPL-3.0 '
    url: 'https://www.gnu.org/licenses/agpl-3.0.en.html'
tags:
  - name: address
    description: >-
      Generate, manage and interact with TRTL addresses generated with TRTL
      Services.
  - name: transfer
    description: >-
      Send and view transactions belonging to TRTL addresses generated with TRTL
      Serfvices.
  - name: wallet
    description: View your Turtle-Service wallet containers registered with TRTL Services.
  - name: status
    description: Get status regarding TRTL Services infrastructure.
paths:
  /address:
    post:
      tags:
        - address
      summary: Create a new adresss.
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                type: object
                properties:
                  address:
                    description: Bad Request
                  blockIndex:
                    type: integer
                    example: 734396
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
  '/address/{address}':
    get:
      tags:
        - address
      summary: Get details of an address.
      parameters:
        - in: path
          name: address
          description: A valid TRTL address registered generated with TRT Services.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                properties:
                  availableBalance:
                    type: integer
                    example: 2039.29
                  lockedBalance:
                    type: integer
                    example: 22.09
                  blockIndex:
                    type: integer
                    example: 734396
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
    delete:
      tags:
        - address
      summary: Delete an address
      parameters:
        - in: path
          name: address
          description: A valid TRTL address registered generated with TRT Services.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                properties:
                  address:
                    type: string
                    example: >-
                      TRTLuxtknTzHFw1GbpJCJxHFtNQdt1vuBHnr84suMomJJ6MZ5R4mUBH9bSvL4L5tKw9Zw377XD87DAZxUBK4DCoXAQQAh5K7szBBdHCpj6hXR7FRUtDFSHooJLRtszmHUFpzPxLRXU8ESfa4b5kSQcPeryDmBbv3aWCewS8x5X8E4kYM17xtYUQHfb3
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
  /address/all:
    get:
      tags:
        - address
      summary: Get all addresses.
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                example:
                  - >-
                    TRTLuzAzNs1E1RBFhteX56A5353vyHuSJ5AYYQfoN97PNbcMDvwQo4pUWHs7SYpuD9ThvA7AD3r742kwTmWh5o9WFaB9JXH8evP
                  - >-
                    TRTLuzAzNs1E1RBFhteX56A5353vyHuSJ5AYYQfoN97PNbcMDvwQo4pUWHs7SYpuD9ThvA7AD3r742kwTmWh5o9WFaB9JXH8evP
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
  '/address/scan/{address}/{blockIndex}':
    get:
      tags:
        - address
      summary: Scan an address for transactions between a 100 block range.
      parameters:
        - in: path
          name: address
          description: A valid TRTL address registered generated with TRT Services.
          required: true
          schema:
            type: string
        - in: path
          name: blockIndex
          description: A valid TRTL block index.
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                example:
                  - address: >-
                      TRTLuzAzNs1E1RBFhteX56A5353vyHuSJ5AYYQfoN97PNbcMDvwQo4pUWHs7SYpuD9ThvA7AD3r742kwTmWh5o9WFaB9JXH8evP
                    amount: 100
                    fee: 1
                    sfee: 2.1
                    transactionHash: >-
                      EohMUzR1DELyeQM9RVVwpmn5Y1DP0lh1b1ZpLQrfXQsgtvGHnDdJSG31nX2yESYZ
                    blockHash: >-
                      b8ItjbZCoGNXbT9OxQyZusNL0KNAS3iTqam0WX1gW6lITnkCkHzlNWSHqH9b4Kx7
                    paymentId: >-
                      VFhcdUodkBmQNEMgKGjCwXo0VPGWsft7frzPJ1T9lyEWXgBVSFzrbNN78vMFaad3
                    timestamp: 1536190370
                    extra: >-
                      KB6DQOFbcctAuOInLtkbtNtl40fG3aoNMelem1VeyjD6tQEO9DPT7Z5B8YbID4LP
                    blockIndex: 735963
                    confirms: 40
                  - address: >-
                      TRTLuzAzNs1E1RBFhteX56A5353vyHuSJ5AYYQfoN97PNbcMDvwQo4pUWHs7SYpuD9ThvA7AD3r742kwTmWh5o9WFaB9JXH8evP
                    amount: 30
                    fee: 0.3
                    sfee: 0.63
                    transactionHash: >-
                      v3ThajDV54R25LLt8Z0lvyVf39hsYCRvEu2LiHDBd2YKUb4hxmOa2R0dT9RQVhPK
                    blockHash: >-
                      4oCsFa6vhxBMJiKJ5rJqOdGxR0tXhq8TY91URj5Sn1i5CBBosz6rdJsl2FtCYhPD
                    paymentId: null
                    extra: >-
                      0TkNvSWhSeLr4Q9U0uaXYqNLYVIKtOAKaM3LlzEK44C3LtypfGLnvIjQKwWZv0M9
                    timestamp: 1536191470
                    blockIndex: 735974
                    confirms: 29
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
  '/address/keys/{address}':
    get:
      tags:
        - address
      summary: Get the public and secret spend key of an address.
      parameters:
        - in: path
          name: address
          description: A valid TRTL address registered generated with TRT Services.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                properties:
                  spendPublicKey:
                    type: string
                    example: >-
                      3ba1a60c3f8697ba4916ccbe5639579abcfd04457428e13c368fadcf893bb949
                  spendSecretKey:
                    type: string
                    example: >-
                      bf2ef03d8293043e65f85e091bd1464ed2d687a1ec4dfa374ef8220f28ff800a
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
  /address/integrate:
    post:
      tags:
        - address
      summary: Create an integrated address with an address and payment ID.
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                type: object
                properties:
                  address:
                    type: string
                    example: >-
                      TRTLuxtknTzHFw1GbpJCJxHFtNQdt1vuBHnr84suMomJJ6MZ5R4mUBH9bSvL4L5tKw9Zw377XD87DAZxUBK4DCoXAQQAh5K7szBBdHCpj6hXR7FRUtDFSHooJLRtszmHUFpzPxLRXU8ESfa4b5kSQcPeryDmBbv3aWCewS8x5X8E4kYM17xtYUQHfb3
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                address:
                  description: A valid TRTL address and paymentId.
                  type: string
                paymentId:
                  description: A 64 hex character string.
                  type: string
              required:
                - address
                - paymentId
  '/address/integrate/{address}':
    get:
      tags:
        - address
      summary: Get all integrated addresses belonging to an address.
      parameters:
        - in: path
          name: address
          description: A valid TRTL address registered generated with TRT Services.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                example:
                  - address: >-
                      TRTLuxtknTzHFw1GbpJCJxHFtNQdt1vuBHnr84suMomJJ6MZ5R4mUBH9bSvL4L5tKw9Zw377XD87DAZxUBK4DCoXAQQAh4sxEq8eiJbesVDs6md1hWnmWgSNVA8N8RrzPY58TASkmN8rkZN4b5kSQcPeryDmBbv3aWCewS8x5X8E4kYM17xtYW1ngoP
                    paymentId: >-
                      7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8803
                  - address: >-
                      TRTLuxtknTzHFw1GbpJCJxHFtNQdt1vuBHnr84suMomJJ6MZ5R4mUBH9bSvL4L5tKw9Zw377XD87DAZxUBK4DCoXAQQAhBRV4yQeiJbesVDs6md1hWnmWgSNVA8N8RrzPY58TASkmN8rkZN4b5kSQcPeryDmBbv3aWCewS8x5X8E4kYM17xtYXRdivT
                    paymentId: >-
                      7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8804
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
  '/transfer/fee/{amount}':
    get:
      tags:
        - transfer
      summary: Calculate the fee in TRTL for a wallet container.
      parameters:
        - in: path
          name: amount
          description: calculate fee for wallet container.
          required: true
          schema:
            type: number
            format: float
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: integer
                example: 29
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
  /transfer:
    post:
      tags:
        - transfer
      summary: Create a new transaction.
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                type: string
                example:
                  transactionHash: >-
                    EohMUzR1DELyeQM9RVVwpmn5Y1DP0lh1b1ZpLQrfXQsgtvGHnDdJSG31nX2yESYZ
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                from:
                  description: A valid TRTL address generated with TRTL Services.
                  type: string
                to:
                  description: A valid TRTL address.
                  type: string
                amount:
                  description: A transaction amount in TRTL with two decimals points.
                  type: number
                  format: float
                fee:
                  description: A network transaction fee in TRTL with two decimal points.
                  type: number
                  format: float
                paymentId:
                  description: A valid 64 hex character string.
                  type: string
                extra:
                  description: A valid 64 hex character string.
                  type: string
              required:
                - from
                - to
                - amount
                - fee
  '/transfer/{transactionHash}':
    get:
      tags:
        - transfer
      summary: Get a transaction created with TRTL Services by hash.
      parameters:
        - in: path
          name: transactionHash
          description: unique 64 character string.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                properties:
                  address:
                    type: string
                    example: >-
                      TRTLuzAzNs1E1RBFhteX56A5353vyHuSJ5AYYQfoN97PNbcMDvwQo4pUWHs7SYpuD9ThvA7AD3r742kwTmWh5o9WFaB9JXH8evP
                  amount:
                    type: number
                    format: float
                    example: 12.49
                  fee:
                    type: number
                    format: float
                    example: 0.1
                  sfee:
                    type: number
                    format: float
                    example: 2.1
                  transactionHash:
                    type: string
                    example: >-
                      EohMUzR1DELyeQM9RVVwpmn5Y1DP0lh1b1ZpLQrfXQsgtvGHnDdJSG31nX2yESYZ
                  blockHash:
                    type: string
                    example: >-
                      b8ItjbZCoGNXbT9OxQyZusNL0KNAS3iTqam0WX1gW6lITnkCkHzlNWSHqH9b4Kx7
                  paymentId:
                    type: string
                    example: >-
                      VFhcdUodkBmQNEMgKGjCwXo0VPGWsft7frzPJ1T9lyEWXgBVSFzrbNN78vMFaad3
                  extra:
                    type: string
                    example: >-
                      KB6DQOFbcctAuOInLtkbtNtl40fG3aoNMelem1VeyjD6tQEO9DPT7Z5B8YbID4LP
                  timestamp:
                    type: integer
                    example: 1536191370
                  blockIndex:
                    type: integer
                    example: 735963
                  confirms:
                    type: integer
                    example: 23
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
  /wallet:
    get:
      tags:
        - wallet
      summary: Get wallet container info and health check.
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                properties:
                  name:
                    type: string
                    example: Web Wallet
                  location:
                    type: string
                    example: Germany
                  host:
                    type: string
                    example: 127.0.0.1
                  port:
                    type: integer
                    example: 8070
                  timeout:
                    type: integer
                    example: 3000
                  fee:
                    type: number
                    format: float
                    example: 1.3
                  availableBalance:
                    type: number
                    format: float
                    example: 92329.25
                  lockedBalance:
                    type: number
                    format: float
                    example: 123.2
                  status:
                    type: integer
                    example: 1
                  blockCount:
                    type: integer
                    example: 988880
                  knownBlockCount:
                    type: integer
                    example: 988880
                  peerCount:
                    type: integer
                    example: 51
                  updated:
                    type: string
                    example: '2018-11-20 01:50:00'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
  /status:
    get:
      tags:
        - status
      summary: Get TRTL Services infrastructure health check.
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                example:
                  - name: chain
                    state: 1
                    status: OK
                    synced: 1
                    blockIndex: 869566
                    timestamp: '2018-10-09 15:23:10'
                  - name: worker
                    state: 1
                    status: Online
                    synced: 1
                    blockIndex: 858855
                    timestamp: '2018-10-09 15:23:10'
                  - name: api
                    state: 1
                    status: Online
                    synced: 1
                    blockIndex: 858855
                    timestamp: '2018-10-09 15:23:10'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Invalid Input
        '412':
          description: Precondition Failed
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
servers:
  - url: 'https://api.trtl.services/v1'
  - url: 'http://api.trtl.services/v1'
components:
  securitySchemes:
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header