Sign in

v1

latestOpenAPI 3.0.02026-07-2241414.1 KB
Reports

Get Reports

get/reports

Query parameters

addressstring

(Optional if a domain is passed). Crypto addresses to screen.

beforestring date-time

Optional. Threshold date to use as a filter.

category'RUG_PULL' | 'UKRANIAN_DONATION_SCAM' | 'DONATION_SCAM' | 'SEXTORTION' | 'SIM_SWAP' | 'PHISHING' | 'RANSOMWARE' | 'CONTRACT_EXPLOIT' | 'AIRDROP' | 'ROMANCE' | 'PIGBUTCHERING' | 'OTHER' | 'FAKE_PROJECT' | 'OTHER_BLACKMAIL' | 'IMPERSONATION' | 'FAKE_RETURNS' | 'UPGRADE_SCAM' | 'MAN_IN_THE_MIDDLE_ATTACK' | 'OTHER_HACK' | 'OTHER_INVESTMENT_SCAM'

Optional. Scam category to use as filter.

chain'BTC' | 'ETH' | 'TRON' | 'SOL' | 'POLYGON' | 'BINANCE' | 'HBAR' | 'CARDANO' | 'LITECOIN' | 'AVALANCHE' | 'MULTIVERSX' | 'ARBITRUM' | 'ALGORAND' | 'BASE' | 'TON'

(Optional if a URL is passed). Chain to use as filter.

checkedboolean

Optional. True: report checked by our team of moderators including blockchain intelligence experts. False: report could not be verified by our team of moderators.

countrystring

Optional. An ISO 3166-1 alpha-2 code e.g. AE for United Arab Emirates, CA for Canada, GB for United Kingdom, etc. Usage: ?country=CA to filter reports within Canada

domainstring

(Optional if an address is passed). URL to screen.

includePrivateboolean

Optional. Defaults to false. Only users with TRM_INTERNAL role can toggle. True: private reports are included in the response. False: private reports are hidden from the response.

minLossAmountnumber double

Optional. Filters reports with at least the amount passed (Currently, only usd asset are supported and others will be ignored).

orderByDirection'ASC' | 'DESC'

ASC = latest reports first. DESC = oldest report first if several reports are pulled out.

orderByField'CREATED_AT' | 'SUBMITTED_BY'

Orders reports by date if several reports are pulled out.

pagenumber double

Optional. Number of pages of reports to pull out. The maximum number of reports per page is 50.

perPagenumber double

Optional. Number of reports to display per page. The maximum number of reports per page is 50.

scammerIocstring

Optional. Filters reports based on passed indicator of compromise.

sincestring date-time

Optional. Start date to use as a filter.

trustedboolean

Optional. True: reported by a trusted contributor, based on how this Partner detects and verifies information. False: the reporter is not registered as a trusted contributor.

usernamestring

Optional. The contributor's username.

Response

Ok

countnumber double required

Example response

{
  "reports": [
    {
      "id": "52907745-7672-470e-a803-a2f8feb52944",
      "trusted": true,
      "checked": true,
      "scamCategory": "RUG_PULL",
      "createdAt": "2022-09-09T04:53:16.591Z",
      "addresses": [
        {
          "address": "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
          "chain": "BTC",
          "domain": null
        },
        {
          "address": null,
          "chain": null,
          "domain": "scammer.com"
        }
      ]
    }
  ]
}