Skip to content

hashlookup CIRCL API API

by circl.lu

No authHTTPSSecurity
Open documentation ↗

Overview

![](https://www.circl.lu/assets/images/circl-logo.png) [CIRCL hash lookup](https://hashlookup.circl.lu/) is a public API to lookup hash values against known database of files. For more details about all the datasets included [visit the website of the project](https://www.circl.lu/services/hashlookup/). The API is accessible via HTTP ReST API and the API is also [described as an OpenAPI](https://hashlookup.circl.lu/swagger.json). A [documentation is available with](https://www.circl.lu/services/hashlookup/) with sample queries and software using hashlookup. An offline version as Bloom filter is also [available](https://circl.lu/services/hashlookup/#how-to-quickly-check-a-set-of-files-in-a-local-directory). The API can be tested live in the interface below.

hashlookup CIRCL API is a security API from circl.lu. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 11 endpoints.

At a glance

Authentication
No auth
HTTPS
Yes
CORS
Unknown
Category
Security
Version
1.2
Endpoints
11
Spec updated
2023-03-06

Endpoints

MethodPathWhat it does
POST/bulk/md5Bulk search of MD5 hashes in a JSON array with the key 'hashes'.
POST/bulk/sha1Bulk search of SHA1 hashes in a JSON array with the 'hashes'.
GET/children/{sha1}/{count}/{cursor}Return children from a given SHA1. A number of element to return and an offset must be given. If not set it will be the 100 first elements. A cursor must be gi
GET/infoInfo about the hashlookup database
GET/lookup/md5/{md5}Lookup MD5.
GET/lookup/sha1/{sha1}Lookup SHA-1.
GET/lookup/sha256/{sha256}Lookup SHA-256.
GET/parents/{sha1}/{count}/{cursor}Return parents from a given SHA1. A number of element to return and an offset must be given. If not set it will be the 100 first elements. A cursor must be give
GET/session/create/{name}Create a session key to keep search context. The session is attached to a name. After the session is created, the header `hashlookup_session` can be set to the
GET/session/get/{name}Return set of matching and non-matching hashes from a session.
GET/stats/topReturn the top 100 of most queried values.

Questions

Does the hashlookup CIRCL API API need an API key?

No. The hashlookup CIRCL API API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the hashlookup CIRCL API API support HTTPS?

Yes, the hashlookup CIRCL API API is served over HTTPS.

How many endpoints does the hashlookup CIRCL API API have?

Its OpenAPI description lists 11 endpoints in version 1.2. All of them are shown on this page.

What are alternatives to the hashlookup CIRCL API API?

Other Security APIs include Microsoft Security Response Center (MSRC), National Vulnerability Database, Cisco PSIRT openVuln API, Shodan, BitWarden.

Compare alternatives →

Microsoft Security Response Center (MSRC)

Security

Programmatic interfaces to engage with the Microsoft Security Response Center (MSRC)

No auth

National Vulnerability Database

Security

U.S. National Vulnerability Database

No auth

Cisco PSIRT openVuln API

Security

The Cisco Product Security Incident Response Team (PSIRT) openVuln API is a RESTful API that allows customers to obtain Cisco Security Vulnerability information in different machine-consumable formats. APIs are important for customers because they allow their technical staff and programmers to build tools that help them do their job more effectively (in this case, to keep up with security vulnerability information). For more information about the Cisco PSIRT openVuln API visit https://developer.cisco.com/site/PSIRT/discover/overview For detail steps on how to use the API go to:https://developer.cisco.com/site/PSIRT/get-started/getting-started.gsp This is a beta release of a swagger YAML for the Cisco PSIRT openVuln API To access the API sign in with your Cisco CCO account at http://apiconsole.cisco.com and register an application to recieve a client_id and a client_secret You can then get your token using curl or any other method you prefer. 'curl -s -k -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "client_id=<your_client_id>" -d "client_secret=<your_client_secret>" -d "grant_type=client_credentials" https://cloudsso.cisco.com/as/token.oauth2' You will receive an access token as demonstrated in the following example: '{"access_token":"I7omWtBDAieSiUX3shOxNJfuy4J6","token_type":"Bearer","expires_in":3599}' In Swagger, click on Change Authentication enter the text "I7omWtBDAieSiUX3shOxNJfuy4J6" (which is the token you received) then click on "Try this operation"

OAuth19 endpoints

Shodan

Security

Search engine for Internet connected devices

API key

BitWarden

Security

Best open-source password manager

OAuth

HaveIBeenPwned

Security

Passwords which have previously been exposed in data breaches

API key

Listed from APIs.guru (CC0).