Skip to content

API reference

Python ⅔ library for the Vulners database provides search, data retrieval, archive, and vulnerability scanning APIs for integration purposes. With this library you can develop game-changing security tools by embracing the power of the world's largest correlated security intelligence, which goes through constant updates and links more than 170 data sources.

API key

Step-by-step guide with screenshots

Please, register at Vulners website. Go to the personal menu by clicking at your name at the right top corner. Click on the API KEYS tab. Generate API key with scope "api" and use it with the library.

Interaction with the Vulners REST API requires an API key. Basically, this version of the documentation provides general examples for REST APIs that can be used with any programming language. For example, you can implement your own Go sdk.

Python SDK

If you are going to use python, you can use Vulners python library. Python library was tested on a python2 and python3. You can use pip for the installation pip install -U vulners. Package is also available with PyPI.

All the callable methods use Vulners REST API. Automate your audit routines with Vulners. Mandatory code that is inserted at the beginning of each code example:

Query: 

POST /api/v3/apiKey/valid/

Input data can be:

  • Query string
  • JSON

Query string example:

curl -XPOST 'https://vulners.com/api/v3/apiKey/valid/?keyID={API key}'

JSON example:

curl -XPOST --compressed https://vulners.com/api/v3/apiKey/valid -H 
'Content-Type: application/json' -d '{
    "keyID": "{API key}"
}'

import vulners

vulners_api = vulners.VulnersApi(api_key="YOUR_API_KEY_HERE")

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")

{
    "result": "OK",
    "data": {
        "valid": true
        }
}
Back to top