API
Oferujemy możliwość łatwego i automatycznego współdziałania z naszą platformą z wykorzystaniem API REST z komunikacją http (GET lub POST). Wyniki są podawane w formacie JSON.
API umożliwia, w zależności od uprawnień, zautomatyzowanie przekazywania adresów URL i/lub wysyłania zapytań o wpisy z bazy i dane kontekstowe, w zależności od różnych kryteriów wyszukiwania.
W przypadku pytań lub jeśli potrzebna jest pomoc w zakresie używania API prosimy o kontakt z nami.
„Autoryzacja”: „Token <mój klucz>”
Twoje konto (poprzez powiązany klucz API) ma uprawnienia do wykonywania następujących działań:
- Masowe zgłaszanie URL
- Kwalifikacja URL
- Sprawdzanie bazy URL
- Zapytanie o URL w bazie danych
-
Wyszukiwanie w kodzie źródłowym stron internetowych
Documentation
Poniżej podane są punkty wejścia i parametry, których można używać w API. Przykłady stosowania, w języku python, są dostępne w oficjalnej bibliotece PyEUPI.
Na żądanie możemy zapewnić wersje w innych językach programowania.
url
Retrieve a list of urls.
Response class
id ( integer , optional )
url ( integer , optional )
tag ( integer , optional )
tag_label ( integer , optional )
first_seen ( integer , optional )
num_seen ( integer , optional )
country ( integer , optional )
last_tagged ( integer , optional )
domain ( integer , optional )
tld ( integer , optional )
ip_address ( integer , optional )
ip_range ( integer , optional )
asn ( integer , optional )
language ( integer , optional )
google_blacklist_update_time ( integer , optional )
}
Parameters
Parameter | Description | Parameter type | Data type |
---|---|---|---|
tag |
URL status. 0 = unknown, 1 = phishing, 2 = clean. |
query | integer |
tag_label |
URL status. Allowed values are "unknown", "phishing" and "clean" |
query | string |
url | query | string | |
url_exact | query | string | |
country | query | string | |
asn | query | integer | |
domain | query | string | |
redirector |
'true' to only have redirector urls, 'false' to filter them |
query | string |
language | query | string | |
tld | query | string | |
ip_address | query | string | |
ip_range |
IP range, using format xxx.xxx.xxx.xxx/xx |
query | string |
first_seen_before |
Date in ISO format |
query | date-time |
first_seen_after |
Date in ISO format |
query | date-time |
last_tagged_before |
Date in ISO format |
query | date-time |
last_tagged_after |
Date in ISO format |
query | date-time |
order_by |
Sort by selected field. Prefix the field by a '-' to have a reverted sort Allowed values: "first_seen", "url", "-first_seen", "-url" |
query | string |
page |
Page to fetch |
query | integer |
page_size |
Element count per page. Maximum is 50. |
query | integer |
Return codes
HTTP return code | Reason |
---|---|
400 | Invalid request |
200 | OK |
Send back informations about the url.
Response class
id ( integer , optional )
url ( integer , optional )
tag ( integer , optional )
tag_label ( integer , optional )
first_seen ( integer , optional )
num_seen ( integer , optional )
country ( integer , optional )
last_tagged ( integer , optional )
domain ( integer , optional )
tld ( integer , optional )
ip_address ( integer , optional )
ip_range ( integer , optional )
asn ( integer , optional )
language ( integer , optional )
google_blacklist_update_time ( integer , optional )
}
Return codes
HTTP return code | Reason |
---|---|
400 | Invalid request |
200 | OK |
Look for an URL qualification
Response class
url ( integer , optional )
tag ( integer , optional )
tag_label ( integer , optional )
}
Parameters
Parameter | Description | Parameter type | Data type |
---|---|---|---|
url |
URL to query |
query | string |
Search for string in URL source codes Restrictions on allowed terms to search may apply to your search depending on your account.
Response class
id ( integer , optional )
url ( integer , optional )
first_seen ( integer , optional )
tag ( integer , optional )
tag_label ( integer , optional )
}
Parameters
Parameter | Description | Parameter type | Data type |
---|---|---|---|
url |
Regular expression to search in the url string |
query | string |
content |
Term to search in the page source code |
query | string |
tag_label |
URL status. Allowed values are "unknown", "phishing" and "clean" |
query | string |
tag |
URL status. 0 = unknown, 1 = phishing, 2 = clean. |
query | integer |
first_seen_after |
URL first submission date from which to search, in ISO 8601 |
query | string |
first_seen_before |
URL first submission date until which to search, in ISO 8601 |
query | string |
page |
Page to fetch |
query | integer |
page_size |
Element count per page. Maximum is 50. |
query | integer |
submission
Retrieve a list of submissions.
Response class
id ( integer , optional )
time ( integer , optional )
submitter_comment ( integer , optional )
submitter_notify ( integer , optional )
url ( integer , optional )
}
id ( integer , optional )
url ( integer , optional )
tag ( integer , optional )
tag_label ( integer , optional )
first_seen ( integer , optional )
num_seen ( integer , optional )
country ( integer , optional )
last_tagged ( integer , optional )
domain ( integer , optional )
tld ( integer , optional )
ip_address ( integer , optional )
ip_range ( integer , optional )
asn ( integer , optional )
language ( integer , optional )
google_blacklist_update_time ( integer , optional )
}
Parameters
Parameter | Description | Parameter type | Data type |
---|---|---|---|
submitted_before |
Date in ISO format |
query | date-time |
submitted_after |
Date in ISO format |
query | date-time |
order_by |
Sort by selected field. Prefix the field by a '-' to have a reverted sort Allowed values: "time", "first_seen", "url", "-time", "-first_seen", "-url" |
query | string |
tag |
URL status. 0 = unknown, 1 = phishing, 2 = clean. |
query | integer |
tag_label |
URL status. Allowed values are "unknown", "phishing" and "clean" |
query | string |
url | query | string | |
url_exact | query | string | |
country | query | string | |
asn | query | integer | |
domain | query | string | |
redirector |
'true' to only have redirector urls, 'false' to filter them |
query | string |
language | query | string | |
tld | query | string | |
ip_address | query | string | |
ip_range |
IP range, using format xxx.xxx.xxx.xxx/xx |
query | string |
first_seen_before |
Date in ISO format |
query | date-time |
first_seen_after |
Date in ISO format |
query | date-time |
last_tagged_before |
Date in ISO format |
query | date-time |
last_tagged_after |
Date in ISO format |
query | date-time |
page |
Page to fetch |
query | integer |
page_size |
Element count per page. Maximum is 50. |
query | integer |
Return codes
HTTP return code | Reason |
---|---|
400 | Invalid request |
200 | OK |
Create one or several submissions.
Response class
id ( integer , optional )
time ( integer , optional )
submitter_comment ( integer , optional )
submitter_notify ( integer , optional )
url ( integer , optional )
}
id ( integer , optional )
url ( integer , optional )
tag ( integer , optional )
tag_label ( integer , optional )
first_seen ( integer , optional )
num_seen ( integer , optional )
country ( integer , optional )
last_tagged ( integer , optional )
domain ( integer , optional )
tld ( integer , optional )
ip_address ( integer , optional )
ip_range ( integer , optional )
asn ( integer , optional )
language ( integer , optional )
google_blacklist_update_time ( integer , optional )
}
Parameters
Parameter | Description | Parameter type | Data type |
---|---|---|---|
body |
dictionary or list of dictionaries of entries to add. Fields:
|
body | string |
Return codes
HTTP return code | Reason |
---|---|
400 | Invalid request |
201 | Created |
Send back informations about the submission.
Response class
id ( integer , optional )
time ( integer , optional )
submitter_comment ( integer , optional )
submitter_notify ( integer , optional )
url ( integer , optional )
}
id ( integer , optional )
url ( integer , optional )
tag ( integer , optional )
tag_label ( integer , optional )
first_seen ( integer , optional )
num_seen ( integer , optional )
country ( integer , optional )
last_tagged ( integer , optional )
domain ( integer , optional )
tld ( integer , optional )
ip_address ( integer , optional )
ip_range ( integer , optional )
asn ( integer , optional )
language ( integer , optional )
google_blacklist_update_time ( integer , optional )
}
Return codes
HTTP return code | Reason |
---|---|
400 | Invalid request |
200 | OK |