> For the complete documentation index, see [llms.txt](https://docs.cyberscope.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cyberscope.io/cyberscan-ai/cyberscan-score-api.md).

# CyberScan - Score API

<mark style="color:green;">`GET`</mark> `https://app.cyberscope.io/api/score`

This endpoint returns the security score for a given blockchain address. To access this API, you must provide the blockchain **address** and **network** as query parameters, and include your **x-api-key** in the request headers and [`supported chains`](https://docs.cyberscope.io/cyberscan-ai/supported-chains)

Example:\
`https://app.cyberscope.io/api/score?address=0xB8c77482e45F1F44dE1745F52C74426C631bDD52&network=ETH`

#### Headers Params

| Name                                        | Type   | Description                                                             |
| ------------------------------------------- | ------ | ----------------------------------------------------------------------- |
| x-api-key<mark style="color:red;">\*</mark> | String | Include the API key in the header of your API requests to authenticate. |

#### Query Params

| Name                                      | Type   | Description                                                                                   |
| ----------------------------------------- | ------ | --------------------------------------------------------------------------------------------- |
| address<mark style="color:red;">\*</mark> | String | <p><code>address</code> <br>The blockchain wallet address for which the request is made</p>   |
| network<mark style="color:red;">\*</mark> | String | The blockchain network associated with the provided address `(e.g. ETH, BNB,POL ,ARB, BASE).` |

### **Request Examples**

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

```shellscript
curl --location 'https://app.cyberscope.io/api/score?address=0xB8c77482e45F1F44dE1745F52C74426C631bDD52&network=ETH' \
--header 'x-api-key: <your-api-key>'
```

{% endtab %}

{% tab title="Node.js (Axios)" %}

```js
const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://app.cyberscope.io/api/score?address=0xB8c77482e45F1F44dE1745F52C74426C631bDD52&network=ETH',
  headers: { 
    'x-api-key': '<your-api-key>'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

```

{% endtab %}

{% tab title="Python (requests)" %}

```python
import requests

url = "https://app.cyberscope.io/api/score?address=0xB8c77482e45F1F44dE1745F52C74426C631bDD52&network=ETH"

payload = {}
headers = {
  'x-api-key': '<your-api-key>'
}

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

print(response.text)

```

{% endtab %}

{% tab title="Java (Java 11+ HttpClient)" %}

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://app.cyberscope.io/api/score?address=0xB8c77482e45F1F44dE1745F52C74426C631bDD52&network=ETH")
  .method("GET", body)
  .addHeader("x-api-key", "<your-api-key>")
  .build();
Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}

### **Response**

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

```json
{
    "success": true,
    "message": "Score fetched successfully",
    "score": 82
}
```

{% endtab %}

{% tab title="400" %}

```json
{
    "success": true,
    "message": "Bad Request",
    "score": null
}
```

{% endtab %}

{% tab title="401" %}

```json
{
  "success": false,
  "message": "Invalid API key or API key not found"
}
```

{% endtab %}
{% endtabs %}

### **Steps to Create a API Key**

{% stepper %}
{% step %}

#### **Log in** to the Dashboard. If you don't have an account, **sign up** to create one.

<figure><img src="/files/AWpNmEdQZvNGoDASIzIP" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### From the sidebar, navigate to API Key Generation.

<figure><img src="/files/0p6R5wvdwReF7m0Aeck3" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Click Create API Key to generate a new API key.

{% endstep %}

{% step %}

#### Copy the generated API key and use the API key to authenticate and test the Out Score API.

<figure><img src="/files/KWsJm1QLsmByCDsiN8k1" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}