SecurityScorecard

Develop on the SecurityScorecard Platform

Create unique customer experiences using our APIs, connect data sources across your technology stack, and build any app or automation you want.

Build apps

Getting Started with SecurityScorecard

You're minutes away from building applications using SecurityScorecard API

Here you'll find quick steps to get you started, but if you get stuck here are some ways to get help:

Step 1. Get an API key

We use API keys to authenticate requests. You can request yours at My Settings > API.

If you are an administrator we recommend you to Authenticate using a Bot User instead, as they let you create multiple API keys you can manage that can be associated to your organization or specific applications instead of being associated to a specific person.

API keys do not expire and are almost as powerful as passwords so be sure to keep them secure! Don't share them publicly, in chat or email, in your source code, in a browser client-side, etc.
Once you obtained one you should only store them in your application secrets.

Note: To revoke your personal API key, simply generate a new one. Administrators can also revoke API keys for any user from My Settings > Users

Step 2. Make a test request

Once you have an API key you can start using endpoints by sending it on the Authorization header. Note: it's important you add the Token prefix (with a space) before your API token.

curl -X GET \
  https://api.securityscorecard.io/portfolios \
  -H 'authorization: Token <your API key>'

the response will look like:

{
  "entries": [{
    "id":"5a134ecae4b06c13a98dca9f",
    "name":"[email protected]",
    "privacy":"private",
    "read_only":true
  },
              
  ...

And you're on your way!

Our API reference includes, for each endpoint, code samples in different programming languages, and lets you try the endpoint directly (click the "Try it" button).
You can try the one above here: Get all portfolios you have access to

Updated about a year ago


What's Next

Alright!, now you're ready explore the Resources in our API, or go straight to some Code Samples

Core Resources
Code Samples

Getting Started with SecurityScorecard


You're minutes away from building applications using SecurityScorecard API

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.