> ## 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. # Snapchat ad API > Call the Snapchat ad API to get name, paid by, brand, profile, account and status, as JSON or markdown. 1 credit. * **Endpoint:** `snapchat.ads.ad` * **Returns:** `data` has `ad`. * **Cost:** 1 credit. Failed calls cost nothing. * **Paging:** No. ## 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.snapchat.ads.ad({ ad: "550e8400-e29b-41d4-a716-446655440000" }); console.log(result.data.ad); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.snapchat.ads.ad(ad="550e8400-e29b-41d4-a716-446655440000") print(result["data"]["ad"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/snapchat/ads/ad \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"ad":"550e8400-e29b-41d4-a716-446655440000"}' ``` ```bash CLI icon="square-terminal" theme={null} stophy snapchat ads ad 550e8400-e29b-41d4-a716-446655440000 ``` ## OpenAPI ````yaml api-reference/openapi.json POST /v1/snapchat/ads/ad 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/snapchat/ads/ad: post: summary: Get a Snapchat ad's details description: Costs 1 credit. operationId: snapchatAdsAd requestBody: required: true content: application/json: schema: type: object properties: ad: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - ad additionalProperties: false 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: ad: type: object additionalProperties: false properties: id: type: string name: type: string paidBy: type: string brand: type: string profile: type: string account: type: string status: type: string type: type: string creativeType: type: string headline: type: string cta: type: object additionalProperties: false properties: text: type: string type: type: string required: [] languages: type: array items: type: string media: type: object additionalProperties: false properties: type: type: string url: type: string format: uri required: [] link: type: object additionalProperties: false properties: url: type: string format: uri title: type: string description: type: string caption: type: string required: [] 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))$ impressions: type: integer minimum: -9007199254740991 maximum: 9007199254740991 countries: type: array items: type: object additionalProperties: false properties: country: type: string impressions: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - impressions targeting: type: object additionalProperties: false properties: ageRanges: type: array items: type: string hasRegulatedContent: type: boolean required: - hasRegulatedContent required: - targeting required: - ad 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 ````