> ## 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. # Meta search ads API > Call the Meta search ads API to get page, is active, first shown at and last shown at, as JSON or markdown. 2 credits per 10 items, at least 2 credits. * **Endpoint:** `meta.ads.search` * **Returns:** `data` has `ads`. * **Cost:** 2 credits per 10 items, at least 2 credits. Failed calls cost nothing. * **Paging:** Yes. Send the `cursor` from the response to get the next page. See [Paging](/advanced-guide#paging). ## Example ```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.meta.ads.search({ query: "nike", limit: 20 }); console.log(result.data.ads); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.meta.ads.search(query="nike", limit=20) print(result["data"]["ads"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/meta/ads/search \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"query":"nike","limit":20}' ``` ```bash CLI icon="square-terminal" theme={null} stophy meta ads search nike --limit 20 ``` ## OpenAPI ````yaml api-reference/openapi.json POST /v1/meta/ads/search 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. Send Accept: text/markdown to get markdown instead of JSON. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. When x-per-items is set, a call costs x-credits for every x-per-items items it returns, and at least x-credits. When a response has a cursor, send it back with the same input to get the next page. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/meta/ads/search: post: summary: Search ads in the Meta ad library description: Costs 2 credits per 10 items. Pages with cursor. operationId: metaAdsSearch requestBody: required: true content: application/json: schema: type: object properties: query: type: string minLength: 1 maxLength: 200 country: default: us pattern: ^(?:[A-Za-z]{2}|[Aa][Ll][Ll])$ description: >- ISO 3166-1 alpha-2 country code, or all. Any case is accepted. type: string adType: default: all type: string enum: - all - politicalAndIssue status: default: active type: string enum: - active - inactive - all mediaType: default: all type: string enum: - all - image - video - meme - none platforms: default: [] maxItems: 4 type: array items: type: string enum: - facebook - instagram - messenger - audienceNetwork from: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ to: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ language: type: string pattern: ^[A-Za-z]{2}$ description: BCP 47 language tag, e.g. en or pt-BR. Any case is accepted. limit: default: 30 type: integer minimum: 1 maximum: 500 cursor: type: string pattern: ^(?:\d{1,4}~(?:[\w-]{10,500})?|(?:[\w-]{10,500}))$ required: - query additionalProperties: false example: query: nike limit: 20 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' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: ads: type: array items: type: object additionalProperties: false properties: id: type: string url: type: string format: uri page: type: object additionalProperties: false properties: id: type: string name: type: string url: type: string format: uri avatar: type: string format: uri categories: type: array items: type: string likes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: [] isActive: type: boolean firstShownAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ lastShownAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ platforms: type: array items: type: string format: type: string text: type: string link: type: object additionalProperties: false properties: url: type: string format: uri title: type: string description: type: string caption: type: string required: [] cta: type: object additionalProperties: false properties: text: type: string type: type: string required: [] images: type: array items: type: object additionalProperties: false properties: url: type: string format: uri caption: type: string alt: type: string required: - url videos: type: array items: type: object additionalProperties: false properties: url: type: string format: uri thumbnail: type: string format: uri required: - url cards: type: array items: type: object additionalProperties: false properties: text: type: string link: type: object additionalProperties: false properties: url: type: string format: uri title: type: string description: type: string caption: type: string required: [] cta: type: object additionalProperties: false properties: text: type: string type: type: string required: [] image: type: string format: uri video: type: object additionalProperties: false properties: url: type: string format: uri thumbnail: type: string format: uri required: - url required: [] versions: type: integer minimum: -9007199254740991 maximum: 9007199254740991 categories: type: array items: type: string paidBy: type: string spend: type: object additionalProperties: false properties: min: type: integer minimum: -9007199254740991 maximum: 9007199254740991 max: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: [] currency: type: string pattern: ^[A-Z]{3}$ description: ISO 4217 currency code, e.g. USD. impressions: type: object additionalProperties: false properties: min: type: integer minimum: -9007199254740991 maximum: 9007199254740991 max: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: [] reach: type: object additionalProperties: false properties: min: type: integer minimum: -9007199254740991 maximum: 9007199254740991 max: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: [] countries: type: array items: type: string required: - url - isActive - versions cursor: type: string required: - ads creditsUsed: type: integer requestId: type: string text/markdown: schema: 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 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 - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string securitySchemes: apiKey: type: http scheme: bearer ````