> ## 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. # Google images API > Search Google Images and get each full-size image with the page it comes from. Call the Google images API for JSON. From 1 credit per call. Searches Google Images and returns each full-size image with the page it comes from. ## Request `query` is required. ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.google.images({ query: "golden retriever puppy" }); console.log(result.data.results); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.google.images(query="golden retriever puppy") print(result["data"]["results"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/google/images \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"query":"golden retriever puppy"}' ``` ```bash CLI icon="square-terminal" theme={null} stophy google images "golden retriever puppy" ``` ## Response If successful, the response body contains the standard envelope. `data.results[]` contains the images, each with its full-size link and the page it comes from. The following example is illustrative. ```json theme={null} { "success": true, "data": { "results": [ { "imageUrl": "https://images.example.com/golden-retriever-puppy.jpg", "title": "Golden retriever puppy in the grass", "pageUrl": "https://www.example.com/dog-breeds/golden-retriever", "source": "example.com", "width": 1600, "height": 1067, "thumbnailUrl": "https://images.example.com/thumbs/golden-retriever-puppy.jpg", "position": 1 } ] }, "creditsUsed": 1, "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b" } ``` | Field | Type | Description | | - | - | - | | `position` | integer | The 1-based position of the result in the list. | For every field, see the response schema on this page. ## Optional parameters | Parameter | Type | Description | | - | - | - | | `country` | string | The country to query, as a two-letter ISO 3166-1 code such as `us`. | | `language` | string | The language of the results, as a two-letter ISO 639-1 code such as `en`. | | `size` | string | Restricts results to images of this size. Acceptable values are `large`, `medium` and `icon`. | | `color` | string | Restricts results to images in this color. Accepts one of 14 values, such as `blackAndWhite`, `transparent` and `red`. | | `type` | string | The kind of image. Acceptable values are `clipArt`, `lineDrawing` and `gif`. | | `time` | string | Restricts results to images from this period. Acceptable values are `past24Hours`, `pastWeek`, `pastMonth` and `pastYear`. | | `usageRights` | string | Restricts results to images with this license. Acceptable values are `creativeCommons` and `commercial`. | | `limit` | integer | The maximum number of images to return. Billed at 1 credit per 10 returned. Must be between 1 and 100. | ## Billing A successful request consumes 1 credit per 10 images, up to 10 credits. Requests that fail, or that return no items, are not billed. Set `limit` to cap the number of items returned and billed. ## Pagination This method is not paginated. A single request returns the complete result. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/google/images 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. 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/google/images: post: summary: >- Search Google Images and get each full-size image with the page it comes from description: Costs 1 credit per 10 images. operationId: googleImages requestBody: required: true content: application/json: schema: type: object properties: query: type: string minLength: 1 maxLength: 400 country: type: string pattern: ^[A-Za-z]{2}$ description: >- ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted. language: type: string pattern: ^[A-Za-z]{2}$ description: >- Two-letter language code like en or pt. Any case is accepted. size: type: string enum: - large - medium - icon color: type: string enum: - blackAndWhite - transparent - red - orange - yellow - green - teal - blue - purple - pink - white - gray - black - brown type: type: string enum: - clipArt - lineDrawing - gif time: type: string enum: - past24Hours - pastWeek - pastMonth - pastYear usageRights: description: Creative Commons, or commercial and other licenses. type: string enum: - creativeCommons - commercial limit: description: >- Return at most this many images. You pay 1 credit per 10 returned. type: integer minimum: 1 maximum: 100 required: - query additionalProperties: false example: query: golden retriever puppy 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: results: type: array items: type: object additionalProperties: false properties: imageUrl: type: string format: uri title: type: string pageUrl: type: string format: uri source: type: string width: type: integer minimum: -9007199254740991 maximum: 9007199254740991 height: type: integer minimum: -9007199254740991 maximum: 9007199254740991 thumbnailUrl: type: string format: uri position: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - imageUrl - pageUrl - width - height - thumbnailUrl - position required: - results creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: 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.