> For the complete documentation index, see [llms.txt](https://apidoc.solidityscan.com/solidityscan-security-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.solidityscan.com/solidityscan-security-api/getting-started/apis/threatscore-api-v2.md).

# ThreatScore API V2

## Tag a webhook

<mark style="color:red;">`POST`</mark> api.solidityscan.com/api-tag-webhook/

This endpoint allows users to register a webhook URL where SolidityScan will send notifications regarding the status of various scans and events. By tagging an endpoint, users can ensure they receive updates directly to their specified URL.

**Headers**

| Name          | Value              |
| ------------- | ------------------ |
| Content-Type  | `application/json` |
| Authorization | `Token <token>`    |

**Body**

| Name               | Type     | Description                                                                             |
| ------------------ | -------- | --------------------------------------------------------------------------------------- |
| `endpoint_url*`    | `string` | The URL where SolidityScan will send event notifications.                               |
| `endpoint_headers` | `json`   | Any headers you supply will be added to the request headers for the requested endpoint. |

**Response**

{% tabs %}
{% tab title="200" %}

```json
{
    "status": "success",
    "message": "Endpoint successfully tagged."
}
```

{% endtab %}

{% tab title="400" %}

```json
{
  "error": "Invalid request"
}
```

{% endtab %}
{% endtabs %}

**Example**

{% tabs %}
{% tab title="Curl" %}

```url
curl --location 'https://api.solidityscan.com/api-tag-webhook/' \
--header 'Authorization: Token <Your Token>' \
--header 'Content-Type: application/json' \
--data '{
    "endpoint_url": "<Your EndPoint URL>",
    "endpoint_headers": {
        "api_key": "val_xyz"
    }
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
import json

url = "https://api.solidityscan.com/api-tag-webhook/"

payload = json.dumps({
  "endpoint_url": "<Your EndPoint URL>"
})
headers = {
  'Authorization': 'Token <Your Token>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
```

{% endtab %}
{% endtabs %}

## Initiate New Scan

<mark style="color:green;">`GET`</mark>api.solidityscan.com/api/v2/threatscan/{contract\_platform}/{contract\_chain}/{contract\_address}

This endpoint initiates a new scan for a specified smart contract deployed on an EVM chain. Users need to provide the platform (e.g., etherscan), the chain (e.g., mainnet), and the contract address. Once the scan is initiated, its status and events will be pushed to the registered webhook URL.

**Headers**

| Name          | Value           |
| ------------- | --------------- |
| Authorization | Token `<token>` |

**Response**

{% tabs %}
{% tab title="200" %}

```json
{
    "data": "Request is being processed. Events will be pushed on endpoints configured",
    "scan_id": "de2bc482ff316c0b",
    "scan_status": "initialised",
    "contract_address": "0x8f9b4525681F3Ea6E43b8E0a57BFfF86c0A1dd2e",
    "contract_platform": "etherscan",
    "contract_chain": "mainnet",
    "request_uuid": "7f91377334a2594d2c8d74cb25316993",
    "status": "success"
}
```

{% endtab %}

{% tab title="400" %}

```json
{
    "status": "failed",
    "message": "Contract address validation failed"
}
```

{% endtab %}
{% endtabs %}

**Example**

{% tabs %}
{% tab title="Curl" %}

```url
curl --location 'https://api.solidityscan.com/api/v2/threatscan/etherscan/mainnet/0x4d1C297d39C5c1277964D0E3f8Aa901493664530' \
--header 'Authorization: Token <Your Token>'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.solidityscan.com/api/v2/threatscan/etherscan/mainnet/0x4d1C297d39C5c1277964D0E3f8Aa901493664530"

payload = {}
headers = {
  'Authorization': 'Token <Your Token>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

```

{% endtab %}
{% endtabs %}

After submitting a request, you will receive events on the webhook. Once the scan is completed and a new request for the same token is sent, you will receive a response similar to this:

{% file src="/files/mCb75TjrETWWWbrKhmVv" %}

Note: No event will be pushed if the same contract is scanned again within 24 hours.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apidoc.solidityscan.com/solidityscan-security-api/getting-started/apis/threatscore-api-v2.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.