Skip to content

Resources API

  • Get Trustpilot supported locales

    This resource will output all supported locales of the Trustpilot system, including URLs to the different Trustpilot sites.

    HTTP method: GET

    Authentication: API Key

    URL: https://api.trustpilot.com/v1/resources/metadata/locales

    Parameters

    • translationLocale, Optional string

      Specifies the language in which the 'translatedName' property is returned.

      Example: ?translationLocale=en-US


    curl -X GET "https://api.trustpilot.com/v1/resources/metadata/locales" \
    -H "apikey: YOUR-API-KEY-HERE"

    Response

    {
    "locales": [
    {
    "locale": "da-DK",
    "language": "da",
    "region": "DK",
    "countryId": 1,
    "nativeName": "Dansk",
    "translatedName": "Danish",
    "tld": "dk",
    "consumerWebApp": "http://www.trustpilot.dk/",
    "businessWebApp": "https://da-dk.b2b.trustpilot.com/",
    "legalUrl": "http://legal.trustpilot.dk",
    "commercialUrl": "http://business.trustpilot.dk",
    "aboutTrustpilotUrl": "http://company.trustpilot.dk",
    "supportUrl": "https://support.trustpilot.com",
    "blog": "http://blog.trustpilot.com",
    "businessSignupUrl": "https://signup.business.trustpilot.com/#/signup?locale=en-US",
    "pressUrl": "https://press.trustpilot.com",
    "investorsUrl": "https://investors.trustpilot.com",
    "jobsUrl": "https://jobs.trustpilot.com",
    "statusPageUrl": "https://status.trustpilot.com",
    "isDefaultForLanguage": true,
    "isSupportedInBusinessWebApp": false
    }
    ],
    "defaultLocale": {
    "locale": "da-DK",
    "language": "da",
    "region": "DK",
    "countryId": 1,
    "nativeName": "Dansk",
    "translatedName": "Danish",
    "tld": "dk",
    "consumerWebApp": "http://www.trustpilot.dk/",
    "businessWebApp": "https://da-dk.b2b.trustpilot.com/",
    "legalUrl": "http://legal.trustpilot.dk",
    "commercialUrl": "http://business.trustpilot.dk",
    "aboutTrustpilotUrl": "http://company.trustpilot.dk",
    "supportUrl": "https://support.trustpilot.com",
    "blog": "http://blog.trustpilot.com",
    "businessSignupUrl": "https://signup.business.trustpilot.com/#/signup?locale=en-US",
    "pressUrl": "https://press.trustpilot.com",
    "investorsUrl": "https://investors.trustpilot.com",
    "jobsUrl": "https://jobs.trustpilot.com",
    "statusPageUrl": "https://status.trustpilot.com",
    "isDefaultForLanguage": true,
    "isSupportedInBusinessWebApp": false
    }
    }
  • Get all countries known to Trustpilot

    This resource will output all countries known to Trustpilot, including the name of the country (in English).

    HTTP method: GET

    Authentication: API Key

    URL: https://api.trustpilot.com/v1/resources/metadata/countries

    Parameters

    • locale, Optional string

      Specifies the language in which the 'translatedName' property is returned.

      Example: ?locale=en-US


    curl -X GET "https://api.trustpilot.com/v1/resources/metadata/countries" \
    -H "apikey: YOUR-API-KEY-HERE"

    Response

    {
    "countries": [
    {
    "countryId": "1",
    "country": "DK",
    "englishName": "Denmark",
    "locale": "da-DK",
    "translatedName": "Danmark"
    }
    ]
    }
  • This resource gives navigational links to all the image resources that are available.

    HTTP method: GET

    Authentication: API Key

    URL: https://api.trustpilot.com/v1/resources/images

    Parameters

    No parameters required

    curl -X GET "https://api.trustpilot.com/v1/resources/images" \
    -H "apikey: YOUR-API-KEY-HERE"

    Response

    {
    "links": [
    {
    "href": "<Url for the resource>",
    "method": "<Http method for the resource>",
    "rel": "<Description of the relation>"
    }
    ]
    }
  • Get the star image resources

    This resource shows you the different sizes that are available, as well as the URLs for the images. Use this resource to get the Trustpilot stars.

    HTTP method: GET

    Authentication: API Key

    URL: https://api.trustpilot.com/v1/resources/images/stars/{stars}

    Parameters

    • stars, Required number

      The number of stars to return images for.

      Example: .../v1/resources/images/stars/4


    curl -X GET "https://api.trustpilot.com/v1/resources/images/stars/{stars}" \
    -H "apikey: YOUR-API-KEY-HERE"

    Response

    {
    "star128x24": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "star256x48": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "star512x96": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "starSvg": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "stars": 4
    }
  • Get the Trustpilot logo images

    This resource shows you the different sizes that are available, as well as the URLs for the images. Use this resource to get the Trustpilot logo.

    HTTP method: GET

    Authentication: API Key

    URL: https://api.trustpilot.com/v1/resources/images/logos

    Parameters

    No parameters required

    curl -X GET "https://api.trustpilot.com/v1/resources/images/logos" \
    -H "apikey: YOUR-API-KEY-HERE"

    Response

    {
    "darkBackground": {
    "logo72x18": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "logo144x36": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "logo288x72": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "logo576x144": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "logoSvg": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    }
    },
    "lightBackground": {
    "logo72x18": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "logo144x36": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "logo288x72": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "logo576x144": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    },
    "logoSvg": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    }
    }
    }
  • Get the Trustpilot icon images

    This resource shows you the different sizes that are available, as well as the URLs for the images. Use this resource to get the Trustpilot icon (checkbox).

    HTTP method: GET

    Authentication: API Key

    URL: https://api.trustpilot.com/v1/resources/images/icons

    Parameters

    No parameters required

    curl -X GET "https://api.trustpilot.com/v1/resources/images/icons" \
    -H "apikey: YOUR-API-KEY-HERE"

    Response

    {
    "image230x230": {
    "url": "//trustpilot.com/image.jpg",
    "width": "400",
    "height": "300"
    }
    }
  • Get the string representation of the stars

    This resource gives the text representation of the stars used to represent the TrustScore as Text. For example: Excellent

    HTTP method: GET

    Authentication: API Key

    URL: https://api.trustpilot.com/v1/resources/strings/stars/{stars}

    Parameters

    • stars, Required number

      The number of stars to return the text representation for.

      Example: .../v1/resources/strings/stars/4


    • locale, Required string

      The locale to use for the string.

      Example: ?locale=da-DK


    curl -X GET "https://api.trustpilot.com/v1/resources/strings/stars/{stars}" \
    -G \
    --data-urlencode "locale=da-DK" \
    -H "apikey: YOUR-API-KEY-HERE"

    Response

    {
    "locale": "en-US",
    "string": "Good",
    "stars": 4
    }