> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Glassdoor glassdoor Company API
> Scrape a Glassdoor company's ratings and details. Call the Glassdoor glassdoor Company API for JSON. 1 credit per call. Every call returns the same flat shape.
Scrape a Glassdoor company's ratings and details. The company or companyName is identified by its URL, ID or companyName.
## Request
Exactly one of `companyUrl`, `companyId` or `companyName` is required. A request that sets more than one, or none, fails with `invalidRequest`.
```typescript TypeScript icon="https://mintlify.s3.us-west-1.amazonaws.com/sirathic/images/icons/typescript.svg" theme={null} theme={null}
import { Stophy } from "stophy";
const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.glassdoor.company({ companyName: "Google" });
console.log(result.data);
```
```python Python icon="python" theme={null} theme={null}
from stophy import Stophy
stophy = Stophy() # reads STOPHY_API_KEY
result = stophy.glassdoor.company(company_name="Google")
print(result["data"])
```
```bash cURL icon="terminal" theme={null} theme={null}
curl -X POST https://api.stophy.dev/v1/glassdoor/company \
-H "Authorization: Bearer $STOPHY_API_KEY" \
-H "content-type: application/json" \
-d '{"companyName":"Google"}'
```
```bash CLI icon="square-terminal" theme={null} theme={null}
stophy glassdoor company --companyName Google
```
## Response
If successful, the response body contains the standard envelope. `data` contains the company's ratings, size, industry and headquarters.
The following example is a real response, truncated: each list shows one item and long strings are cut.
```json theme={null}
{
"success": true,
"data": {
"companyId": "9079",
"companyUrl": "https://www.glassdoor.com/Overview/Working-at-Google-EI_IE9079.11,17.htm",
"name": "Google",
"rating": 4.4,
"reviews": 71507,
"cultureRating": 4.2,
"workLifeBalanceRating": 4.2,
"payRating": 4.5,
"managementRating": 3.9,
"careerOpportunitiesRating": 4.2,
"recommendPercent": 88,
"ceoApprovalPercent": 84,
"size": "10000+ Employees",
"industry": "Internet & Web Services",
"headquarters": "Mountain View, CA",
"website": "https://goo.gle/4ehVuXi"
},
"creditsUsed": 1,
"requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```
| Field | Type | Description |
| - | - | - |
| `rating` | number | The average star rating, on a scale of 1 to 5. |
| `reviews` | integer | Reviews in every language. |
For every field, see the response schema on this page.
## Billing
Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.
## Pagination
This method is not paginated. A single request returns the complete result.
## Related methods
* [Glassdoor glassdoor Company Reviews](/api-reference/endpoint/glassdoor-company-reviews): Accepts `companyUrl`. Scrape a Glassdoor company's employee reviews.
* [Glassdoor glassdoor Company Salaries](/api-reference/endpoint/glassdoor-company-salaries): Accepts `companyUrl`. Scrape a Glassdoor company's salaries by job title.
## OpenAPI
````yaml api-reference/openapi.json POST /v1/glassdoor/company
openapi: 3.1.0
info:
title: Stophy API
version: '1'
description: >-
Every endpoint is a POST that takes its input as a JSON object body. Unknown
fields are rejected with 400.
Responses leave out empty values: null, empty strings, empty objects and
empty nested lists are not sent.
Text comes back whole. To get shorter responses, add
?maxTextLength= to the URL. Every text value longer than that is
cut and ends with …. A screenshot is never cut, and a page whose text was
cut has isTruncated set to true.
x-credits is what one call costs. Every call costs the same, whatever it
returns, unless an operation's description says it costs per 10 results, or
per second of audio. Then x-credits is the lowest price and x-credits-max
the most one call can cost. Where an operation takes limit, send it to
return fewer results and pay for fewer.
When a response has a cursor, send it back unchanged with the same input to
get the next page. When it has a page, send the next page number.
servers:
- url: https://api.stophy.dev
security:
- apiKey: []
paths:
/v1/glassdoor/company:
post:
summary: Scrape a Glassdoor company's ratings and details
description: Costs 1 credit per call.
operationId: glassdoorCompany
parameters:
- $ref: '#/components/parameters/MaxTextLength'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
companyUrl:
type: string
description: >-
Link to the Glassdoor company, like
https://www.glassdoor.com/Overview/Working-at-Google-EI_IE9079.11,17.htm.
Send this or companyId.
companyId:
type: string
description: Glassdoor company id, like 9079. Send this or companyUrl.
companyName:
type: string
description: Glassdoor company name, like Google.
sendOne:
- companyUrl
- companyId
- companyName
additionalProperties: false
example:
companyName: Google
responses:
'200':
description: The data, and the credits this call used.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
x-credits-used:
$ref: '#/components/headers/CreditsUsed'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
x-cache:
$ref: '#/components/headers/Cache'
x-cache-age:
$ref: '#/components/headers/CacheAge'
content:
application/json:
schema:
type: object
required:
- success
- data
- creditsUsed
- requestId
properties:
success:
const: true
data:
type: object
additionalProperties: false
properties:
companyId:
type: string
companyUrl:
type: string
format: uri
name:
type: string
rating:
type: number
minimum: 1
maximum: 5
reviews:
description: Reviews in every language.
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
cultureRating:
type: number
minimum: 1
maximum: 5
workLifeBalanceRating:
type: number
minimum: 1
maximum: 5
payRating:
type: number
minimum: 1
maximum: 5
managementRating:
type: number
minimum: 1
maximum: 5
careerOpportunitiesRating:
type: number
minimum: 1
maximum: 5
recommendPercent:
type: integer
minimum: 0
maximum: 100
ceoApprovalPercent:
type: integer
minimum: 0
maximum: 100
size:
type: string
industry:
type: string
headquarters:
type: string
website:
type: string
format: uri
required: []
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
parameters:
MaxTextLength:
name: maxTextLength
in: query
required: false
description: >-
Cut every text value in the response to this many characters. A value
that was cut ends with …, and a page whose text was cut has isTruncated
set to true. A screenshot is never cut. Leave it out to get the full
text.
schema:
type: integer
minimum: 1
headers:
RequestId:
description: The request id. Quote it when you report a problem.
schema:
type: string
CreditsUsed:
description: Credits this call used.
schema:
type: integer
RateLimitLimit:
description: Requests allowed in the current window.
schema:
type: integer
RateLimitRemaining:
description: Requests left in the current window.
schema:
type: integer
RateLimitReset:
description: Unix time in seconds when the current window resets.
schema:
type: integer
Cache:
description: hit if this result came from the cache, miss if it was fetched live.
schema:
type: string
CacheAge:
description: Seconds since the returned result was written to the cache.
schema:
type: integer
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
responses:
Error:
description: The request failed. retryable says whether trying again can help.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
required:
- success
- error
properties:
success:
const: false
error:
type: object
required:
- code
- message
- retryable
- requestId
properties:
code:
type: string
enum:
- cliSessionCompleted
- cliSessionExists
- cliSessionNotFound
- forbidden
- insufficientCredits
- internalError
- inviteClaimed
- inviteDisabled
- inviteExpired
- inviteUsedUp
- invalidCliSession
- invalidCliVerifier
- invalidRequest
- notFound
- rateLimited
- sourceChanged
- sourceRefused
- sourceTimeout
- sourceUnavailable
- tooManyInFlight
- unauthorized
- unsupportedMediaType
message:
type: string
retryable:
type: boolean
retryAfterSeconds:
type: integer
requestId:
type: string
requiredCredits:
type: number
availableCredits:
type: number
billingUrl:
type: string
const: https://stophy.dev/billing
securitySchemes:
apiKey:
type: http
scheme: bearer
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.