# Cardano Shield API

For a custom API Key, please contact <team@cardanoshield.com>, dm us on [twitter/x](https://twitter.com/CardanoShield), or raise an issue on our [github](https://github.com/adabox-aio/cardano-shield/issues)

## Wallet To Wallet Transaction Scan

{% openapi src="<https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FwhAFEFvG71YRuKqrM9UP%2Fapi-docs.json?alt=media&token=813739dc-9500-40dd-b0b0-c1f6210c3c01>" path="/api/v1/tx/w2wscan" method="post" %}
[api-docs.json](https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FwhAFEFvG71YRuKqrM9UP%2Fapi-docs.json?alt=media\&token=813739dc-9500-40dd-b0b0-c1f6210c3c01)
{% endopenapi %}

**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

{% openapi src="<https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FwhAFEFvG71YRuKqrM9UP%2Fapi-docs.json?alt=media&token=813739dc-9500-40dd-b0b0-c1f6210c3c01>" path="/api/v1/tx/scan" method="post" %}
[api-docs.json](https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FwhAFEFvG71YRuKqrM9UP%2Fapi-docs.json?alt=media\&token=813739dc-9500-40dd-b0b0-c1f6210c3c01)
{% endopenapi %}

**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

{% openapi src="<https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FwhAFEFvG71YRuKqrM9UP%2Fapi-docs.json?alt=media&token=813739dc-9500-40dd-b0b0-c1f6210c3c01>" path="/api/v1/url/scan" method="get" %}
[api-docs.json](https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FwhAFEFvG71YRuKqrM9UP%2Fapi-docs.json?alt=media\&token=813739dc-9500-40dd-b0b0-c1f6210c3c01)
{% endopenapi %}

* 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.