Main Site HUB Security Scorecard API 2.5. Security Ratings Across An Industry

HUB

2.5. Security Ratings Across An Industry

Security Ratings Across An Industry

Along with security risk ratings for a company, SecurityScorecard also publishes security ratings for an industry based on the scores of the companies in that industry group. This is useful contextual information and helpful in understanding where a company stands in it's peer group.

Here are a set of industries you can pull scores for:

  • construction - Construction
  • education - Education
  • energy - Energy
  • entertainment - Entertainment
  • financial_services - Financial Services
  • food - Food
  • government - Government
  • healthcare - Healthcare
  • hospitality - Hospitality
  • information_services - Information Services
  • legal - Legal
  • manufacturing - Manufacturing
  • non profit - Non Profit
  • pharmaceutical - Pharmaceutical
  • retail - Retail
  • technology - Technology
  • telecommunications - Telecommunications
  • transportation - Transportation

 

Get The Top Level Grade For An Industry

This API endpoint allows you to get the top level grade and score for an industry. You can check out the full specification for this endpoint here.

Resource URI

/industries/{industry}/score

Parameters:

Name Required Description
Industry Y The code of the industry you want to pull scores for.

Sample Code:


            curl -X GET \
                https://api.securityscorecard.io/industries/transportation/score \
                -H 'Accept: application/json' \
                -H 'Authorization: Token <Your API Key>' \
                -H 'Content-Type: application/json' \
                -H 'cache-control: no-cache'
        

Sample Response:


{
    "avg_grade": "B",
    "avg_score": 88,
    "industry": "transportation"
}
        

 

Get The Factor Level Grades For An Industry

This API endpoint allows you to get the factor level grades and score for an industry. You can check out the full specification for this endpoint here.

Resource URI

/industries/{industry}/factors

Parameters:

Name Required Description
Industry Y The code of the industry you want to pull scores for.

Sample Code:


            curl -X GET \
                https://api.securityscorecard.io/industries/technology/factors \
                -H 'Accept: application/json' \
                -H 'Authorization: Token <Your API Key>' \
                -H 'Content-Type: application/json' \
                -H 'cache-control: no-cache'
        

Sample Response:


{
    "entries": [
        {
            "name": "application_security",
            "score": 69
        },
        {
            "name": "cubit_score",
            "score": 90
        },
        {
            "name": "dns_health",
            "score": 75
        },
        {
            "name": "endpoint_security",
            "score": 93
        },
        {
            "name": "hacker_chatter",
            "score": 100
        },
        {
            "name": "ip_reputation",
            "score": 93
        },
        {
            "name": "leaked_information",
            "score": 100
        },
        {
            "name": "network_security",
            "score": 85
        },
        {
            "name": "patching_cadence",
            "score": 85
        },
        {
            "name": "social_engineering",
            "score": 100
        }
    ]
}
        

 

Get The Historical Top Level Grades For An Industry

This API endpoint allows you to get the historical top level grades and scores for an industry. You can check out the full specification for this endpoint here.

Resource URI

/industries/{industry}/history/score?from={from}&to={to}

Parameters:

Name Required Description
Industry Y The code of the industry you want to pull scores for.
From Y The historical start date (2019-01-01)
To Y The historical end date (2019-08-01)

Sample Code:


            curl -X GET \
                https://api.securityscorecard.io/industries/technology/history/score?from=2019-09-12&to=2019-09-15 \
                -H 'Accept: application/json' \
                -H 'Authorization: Token <Your API Key>' \
                -H 'Content-Type: application/json' \
                -H 'cache-control: no-cache'
        

Sample Response:


{
    "entries": [
        {
            "avgScore": 84,
            "date": "2019-09-12T00:00:00.000Z",
            "industry": "technology",
            "maxScore": 100,
            "minScore": 25
        },
        {
            "avgScore": 84,
            "date": "2019-09-13T00:00:00.000Z",
            "industry": "technology",
            "maxScore": 100,
            "minScore": 25
        },
        {
            "avgScore": 84,
            "date": "2019-09-14T00:00:00.000Z",
            "industry": "technology",
            "maxScore": 100,
            "minScore": 25
        },
        {
            "avgScore": 84,
            "date": "2019-09-15T00:00:00.000Z",
            "industry": "technology",
            "maxScore": 100,
            "minScore": 25
        }
    ]
}
        

 

Get The Historical Factor Level Grades For An Industry

This API endpoint allows you to get the historical factor level grades and scores for an industry. You can check out the full specification for this endpoint here.

Resource URI

/industries/{industry}/history/factors?from={from}&to={to}

Parameters:

Name Required Description
Industry Y The code of the industry you want to pull scores for.
From Y The historical start date (2019-01-01)
To Y The historical end date (2019-08-01)

Sample Code:


            curl -X GET \
                https://api.securityscorecard.io/industries/technology/history/factors?to=2019-09-20&from=2019-09-18 \
                -H 'Accept: application/json' \
                -H 'Authorization: Token <Your API Key>' \
                -H 'Content-Type: application/json' \
                -H 'cache-control: no-cache'
        

Sample Response:


{
    "entries": [
        {
            "date": "2019-09-18T00:00:00.000Z",
            "factors": [
                {
                    "name": "application_security",
                    "score": 70
                },
                {
                    "name": "cubit_score",
                    "score": 91
                },
                {
                    "name": "dns_health",
                    "score": 75
                },
                {
                    "name": "endpoint_security",
                    "score": 92
                },
                {
                    "name": "hacker_chatter",
                    "score": 100
                },
                {
                    "name": "ip_reputation",
                    "score": 93
                },
                {
                    "name": "leaked_information",
                    "score": 100
                },
                {
                    "name": "network_security",
                    "score": 81
                },
                {
                    "name": "patching_cadence",
                    "score": 85
                },
                {
                    "name": "social_engineering",
                    "score": 100
                }
            ]
        },
        {
            "date": "2019-09-19T00:00:00.000Z",
            "factors": [
                {
                    "name": "application_security",
                    "score": 71
                },
                {
                    "name": "cubit_score",
                    "score": 92
                },
                {
                    "name": "dns_health",
                    "score": 76
                },
                {
                    "name": "endpoint_security",
                    "score": 93
                },
                {
                    "name": "hacker_chatter",
                    "score": 100
                },
                {
                    "name": "ip_reputation",
                    "score": 93
                },
                {
                    "name": "leaked_information",
                    "score": 100
                },
                {
                    "name": "network_security",
                    "score": 81
                },
                {
                    "name": "patching_cadence",
                    "score": 86
                },
                {
                    "name": "social_engineering",
                    "score": 100
                }
            ]
        },
        {
            "date": "2019-09-20T00:00:00.000Z",
            "factors": [
                {
                    "name": "application_security",
                    "score": 72
                },
                {
                    "name": "cubit_score",
                    "score": 93
                },
                {
                    "name": "dns_health",
                    "score": 77
                },
                {
                    "name": "endpoint_security",
                    "score": 93
                },
                {
                    "name": "hacker_chatter",
                    "score": 100
                },
                {
                    "name": "ip_reputation",
                    "score": 94
                },
                {
                    "name": "leaked_information",
                    "score": 100
                },
                {
                    "name": "network_security",
                    "score": 82
                },
                {
                    "name": "patching_cadence",
                    "score": 86
                },
                {
                    "name": "social_engineering",
                    "score": 100
                }
            ]
        }
    ]
}