🛡️
Cardano Shield
  • Overview
  • Cardano Shield API
Powered by GitBook
On this page

Cardano Shield API

PreviousOverview

Last updated 1 year ago

For a custom API Key, please contact team@cardanoshield.com, dm us on , or raise an issue on our

Wallet To Wallet Transaction Scan

Response Body field's explanation:

  • addressRisk

    • suspicious - The address has been identified as potentially malicious.

    • unknown - The address is likely not phishing, but not 100% confident.

    • blacklist - The address is in Cardano Shield's blacklist.

    • whitelist - The address is in Cardano Shield's whitelist.

  • Score

    • low - The transaction overall risk score is Low.

    • medium - The transaction overall risk score is Medium.

    • High - The transaction overall risk score is High.

dApp Transaction Scan

Response Body field's explanation:

  • domainRisk

    • suspicious - The website has been identified as potentially phishing.

    • unknown - The website is likely not phishing, but not 100% confident.

    • blacklist - The website is in Cardano Shield's blacklist.

    • whitelist - The website is in Cardano Shield's whitelist.

  • addressRisk

    • suspicious - The address has been identified as potentially malicious.

    • unknown - The address is likely not phishing, but not 100% confident.

    • blacklist - The address is in Cardano Shield's blacklist.

    • whitelist - The address is in Cardano Shield's whitelist.

  • receivingRisk

    • true - There's a high probability the user is not receiving enough ADA/Tokens.

    • false - There's a high probability the user is receiving the right amount of ADA/Tokens.

  • Score

    • low - The transaction overall risk score is Low.

    • medium - The transaction overall risk score is Medium.

    • High - The transaction overall risk score is High.

URL Phishing Scan

  • suspicious - The website has been identified as potentially phishing.

  • unknown - The website is likely not phishing, but not 100% confident.

  • blacklist - The website is in Cardano Shield's blacklist.

  • whitelist - The website is in Cardano Shield's whitelist.

twitter/x
github

Scan URL for Phishing Detection

get

Scan URL for Phishing Detection

Authorizations
Query parameters
urlstringRequired
Responses
200
Successful Handling
*/*
Responsestring · enumPossible values:
400
Bad Request
*/*
403
Forbidden
*/*
500
Internal Server Error
*/*
get
GET /api/v1/url/scan HTTP/1.1
Host: api.cardanoshield.com
Authorization: Bearer JWT
Accept: */*

suspicious
  • Wallet To Wallet Transaction Scan
  • POSTScan Wallet to Wallet Transaction for Scam Detection
  • dApp Transaction Scan
  • POSTScan Transaction for Scam Detection
  • URL Phishing Scan
  • GETScan URL for Phishing Detection

Scan Wallet to Wallet Transaction for Scam Detection

post

Scan Wallet to Wallet Transaction for Scam Detection

Authorizations
Body
cborHexstringRequired
toAddressstringRequired
fromAddressstringRequired
Responses
200
Successful Handling
*/*
400
Bad Request
*/*
403
Forbidden
*/*
500
Internal Server Error
*/*
post
POST /api/v1/tx/w2wscan HTTP/1.1
Host: api.cardanoshield.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "cborHex": "text",
  "toAddress": "text",
  "fromAddress": "text"
}
{
  "addressRisk": "suspicious",
  "score": "low"
}

Scan Transaction for Scam Detection

post

Scan Transaction for Scam Detection

Authorizations
Body
cborHexstringRequired
toAddressstringRequired
fromAddressstringRequired
urlstringRequired
Responses
200
Successful Handling
*/*
400
Bad Request
*/*
403
Forbidden
*/*
500
Internal Server Error
*/*
post
POST /api/v1/tx/scan HTTP/1.1
Host: api.cardanoshield.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "cborHex": "text",
  "toAddress": "text",
  "fromAddress": "text",
  "url": "text"
}
{
  "domainRisk": "suspicious",
  "addressRisk": "suspicious",
  "receivingRisk": true,
  "score": "low"
}