MENU navbar-image

Introduction

API platform that leverages the power of AI to detect malicious URLs and protect your online security.

This documentation aims to provide all the information you need to work with our API. An account with a valid API token is required to use the API..

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_API_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by creating an account then creating an API token.

Endpoints

requires authentication

Example request:
curl --request POST \
    "https://linkshieldapi.com/api/v1/link/score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"http:\\/\\/gerhold.com\\/\",
    \"follow_redirects\": false
}"

const url = new URL(
    "https://linkshieldapi.com/api/v1/link/score"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "url": "http:\/\/gerhold.com\/",
    "follow_redirects": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://linkshieldapi.com/api/v1/link/score',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'url' => 'http://gerhold.com/',
            'follow_redirects' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://linkshieldapi.com/api/v1/link/score'
payload = {
    "url": "http:\/\/gerhold.com\/",
    "follow_redirects": false
}
headers = {
  'Authorization': 'Bearer {YOUR_API_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

requires authentication

Example request:
curl --request POST \
    "https://linkshieldapi.com/api/v1/link/bulk-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"urls\": [],
    \"follow_redirects\": true
}"

const url = new URL(
    "https://linkshieldapi.com/api/v1/link/bulk-score"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "urls": [],
    "follow_redirects": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://linkshieldapi.com/api/v1/link/bulk-score',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'urls' => [],
            'follow_redirects' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://linkshieldapi.com/api/v1/link/bulk-score'
payload = {
    "urls": [],
    "follow_redirects": true
}
headers = {
  'Authorization': 'Bearer {YOUR_API_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()