synapsecns/sanguine

View on GitHub
contrib/screener-api/docs/swagger.yaml

Summary

Maintainability
Test Coverage
definitions:
  db.BlacklistedAddress:
    properties:
      address:
        type: string
      createdAt:
        type: string
      id:
        type: string
      network:
        type: string
      remark:
        type: string
      tag:
        type: string
      type:
        type: string
      updatedAt:
        type: string
    type: object
info:
  contact: {}
paths:
  /api/data/sync:
    post:
      consumes:
      - application/json
      description: blacklist an address
      parameters:
      - description: Application ID
        in: header
        name: appid
        required: true
        type: string
      - description: Timestamp of the request
        in: header
        name: timestamp
        required: true
        type: string
      - description: A unique nonce for the request
        in: header
        name: nonce
        required: true
        type: string
      - description: Query string parameters included in the request
        in: header
        name: queryString
        required: true
        type: string
      - description: Signature for request validation
        in: header
        name: signature
        required: true
        type: string
      - description: Blacklist request
        in: body
        name: request
        required: true
        schema:
          $ref: '#/definitions/db.BlacklistedAddress'
      produces:
      - application/json
      responses: {}
      summary: blacklist an address
  /screen/{address}:
    get:
      consumes:
      - application/json
      - application/json
      description: Screen an address using Chainalysis API to determine if it's high
        risk
      parameters:
      - description: Address to be screened
        in: path
        name: address
        required: true
        type: string
      produces:
      - application/json
      - application/json
      responses: {}
      summary: Screen an address for risk
      tags:
      - Address Screening
swagger: "2.0"