openapi: 3.1.0
info:
  title: YepAPI API
  version: '2026-10-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-08: 7 operation(s) read from 9 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; YepAPI has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 9
    documentation: -2
    pages-with-code: 9
    pages-read: 9
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.yepapi.com/reference/keyword-filters
  - https://docs.yepapi.com/serp-api/bing
  - https://docs.yepapi.com/maps-api/photo
  - https://docs.yepapi.com/maps-api/place
  - https://docs.yepapi.com/serp-api/yahoo
  - https://docs.yepapi.com/email-api/count
  - https://docs.yepapi.com/maps-api/search
  - https://docs.yepapi.com/serp-api/google
  - https://docs.yepapi.com/tiktok-api/user
servers:
- url: https://api.yepapi.com
paths:
  /v1/email/count:
    post:
      operationId: post_v1_email_count
      tags:
      - Email
      summary: POST /v1/email/count
      x-source: https://docs.yepapi.com/email-api/count
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1EmailCountResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.yepapi.com/v1/email/count  -H \" x-api-key: YOUR_API_KEY \"  -H \" Content-Type: application/json \"\
          \  -d ' {\"domain\": \"stripe.com\"} ' \n Request Body \n Parameter Type Required Description Default domain string Yes Domain to count\
          \ emails for (e.g., stripe.com ) — \n Response \n Response 200 { \n \" data \" : { \n \" byDepartment \" : { \n \" accounting \" : 27\
          \ , \n \" administrative \" : 14 ,"
  /v1/maps/{mapid}:
    post:
      operationId: post_v1_maps_mapid
      tags:
      - Maps
      summary: POST /v1/maps/photo
      x-source: https://docs.yepapi.com/maps-api/photo
      parameters:
      - name: mapid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1MapsMapidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.yepapi.com/v1/maps/photo  -H \" x-api-key: YOUR_API_KEY \"  -H \" Content-Type: application/json \"\
          \  -d ' {\"reference\": \"places/ChIJBR3G8LJqkFQRWD2Wzn0qG3c/photos/AU_ZVEFd3Y9YtVSYWUZf4lY...\", \"max_width\": 1200} ' \n Request\
          \ Body \n Parameter Type Required Description Default reference string Yes Photo resource name from photos[].reference : places/{place_id}/photos/{token}\
          \ . The"
        collapsed_from: 3 example path(s) differing only at mapId
  /v1/seo/keywords:
    post:
      operationId: post_v1_seo_keywords
      tags:
      - Seo
      summary: Keyword Filters
      x-source: https://docs.yepapi.com/reference/keyword-filters
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1SeoKeywordsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/seo/keywords/{keywordid}:
    post:
      operationId: post_v1_seo_keywords_keywordid
      tags:
      - Seo
      summary: POST /v1/seo/keywords/ideas
      x-source: https://docs.yepapi.com/reference/keyword-filters
      parameters:
      - name: keywordid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.yepapi.com/v1/seo/keywords/ideas  -H \" x-api-key: YOUR_API_KEY \"  -H \" Content-Type: application/json\
          \ \"  -d ' { \n \"keyword\": \"running shoes\", \n \"limit\": 100, \n \"filters\": [ \n { \"field\": \"volume\", \"op\": \">=\", \"\
          value\": 500 }, \n { \"field\": \"difficulty\", \"op\": \"<\", \"value\": 40 }, \n { \"field\": \"intent\", \"op\": \"in\", \"value\"\
          : [\"informational\", \"commercial\"] } \n ], \n \"match\": \"all"
        collapsed_from: 2 example path(s) differing only at keywordId
  /v1/seo/{seoid}/keywords:
    post:
      operationId: post_v1_seo_seoid_keywords
      tags:
      - Seo
      summary: Keyword Filters
      x-source: https://docs.yepapi.com/reference/keyword-filters
      parameters:
      - name: seoid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1SeoSeoidKeywordsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at seoId
  /v1/serp/{serpid}:
    post:
      operationId: post_v1_serp_serpid
      tags:
      - Serp
      summary: POST /v1/serp/bing
      x-source: https://docs.yepapi.com/serp-api/bing
      parameters:
      - name: serpid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1SerpSerpidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.yepapi.com/v1/serp/bing  -H \" x-api-key: YOUR_API_KEY \"  -H \" Content-Type: application/json \"\
          \  -d ' {\"query\": \"typescript vs javascript performance\", \"depth\": 10} ' \n Request Body \n Parameter Type Required Description\
          \ Default query string Yes Search query to look up on Bing — depth number No Number of results to return (max 100 ) 10 location_code\
          \ number No Target country "
        collapsed_from: 3 example path(s) differing only at serpId
  /v1/tiktok/user:
    post:
      operationId: post_v1_tiktok_user
      tags:
      - Tiktok
      summary: POST /v1/tiktok/user
      x-source: https://docs.yepapi.com/tiktok-api/user
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1TiktokUserResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.yepapi.com/v1/tiktok/user  -H \" x-api-key: YOUR_API_KEY \"  -H \" Content-Type: application/json \"\
          \  -d ' {\"unique_id\": \"chefmaria\"} ' \n Request Body \n Parameter Type Required Description Default unique_id string Yes TikTok\
          \ username (without @) — \n Response \n Response 200 { \n \" ok \" : true , \n \" data \" : { \n \" user_id \" : \" 6842123456789012345\
          \ \" , \n \" unique_id \" : \" chefmari"
components:
  schemas:
    PostV1EmailCountResponse:
      type: object
      properties:
        ' data ':
          type: object
          properties:
            ' byDepartment ':
              type: object
              properties:
                ' accounting ':
                  type: integer
                ' administrative ':
                  type: integer
                ' communication ':
                  type: integer
                ' diversity ':
                  type: integer
                ' education ':
                  type: integer
                ' engineering ':
                  type: integer
                ' executive ':
                  type: integer
                ' facilities ':
                  type: integer
                ' finance ':
                  type: integer
                ' healthcare ':
                  type: integer
                ' hr ':
                  type: integer
                ' it ':
                  type: integer
                ' legal ':
                  type: integer
                ' management ':
                  type: integer
                ' marketing ':
                  type: integer
                ' operations ':
                  type: integer
                ' pr ':
                  type: integer
                ' sales ':
                  type: integer
                ' security ':
                  type: integer
                ' software ':
                  type: integer
                ' support ':
                  type: integer
                ' warehouse ':
                  type: integer
            ' bySeniority ':
              type: object
              properties:
                ' executive ':
                  type: integer
                ' junior ':
                  type: integer
                ' senior ':
                  type: integer
            ' genericEmails ':
              type: integer
            ' personalEmails ':
              type: integer
            ' total ':
              type: integer
        ' ok ':
          type: boolean
    PostV1MapsMapidResponse:
      type: object
      properties:
        ' ok ':
          type: boolean
        ' data ':
          type: object
          properties:
            ' reference ':
              type: string
            ' photoUri ':
              type: string
    PostV1SeoKeywordsRequest:
      type: object
      properties:
        filters:
          type: object
          description: Up to 8 filter expressions (see below)
        match:
          type: string
          description: 'How to combine filters: "all" (AND) or "any" (OR)'
        sort:
          type: string
          description: Up to 3 sort rules, e.g. "volume:desc"
    PostV1SeoSeoidKeywordsRequest:
      type: object
      properties:
        filters:
          type: object
          description: Up to 8 filter expressions (see below)
        match:
          type: string
          description: 'How to combine filters: "all" (AND) or "any" (OR)'
        sort:
          type: string
          description: Up to 3 sort rules, e.g. "volume:desc"
    PostV1SerpSerpidResponse:
      type: object
      properties:
        ' ok ':
          type: boolean
        ' data ':
          type: object
          properties:
            ' query ':
              type: string
            ' totalResults ':
              type: integer
            ' results ':
              type: array
              items:
                type: object
                properties:
                  ' position ':
                    type: integer
                  ' type ':
                    type: string
                  ' title ':
                    type: string
                  ' url ':
                    type: string
                  ' description ':
                    type: string
                  ' domain ':
                    type: string
    PostV1TiktokUserResponse:
      type: object
      properties:
        ' ok ':
          type: boolean
        ' data ':
          type: object
          properties:
            ' user_id ':
              type: string
            ' unique_id ':
              type: string
            ' nickname ':
              type: string
            ' avatar ':
              type: string
            ' signature ':
              type: string
            ' is_verified ':
              type: boolean
            ' region ':
              type: string
            ' language ':
              type: string
            ' follower_count ':
              type: integer
            ' following_count ':
              type: integer
            ' heart_count ':
              type: integer
            ' video_count ':
              type: integer
            ' digg_count ':
              type: integer
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
security:
- apiKey: []
tags:
- name: Email
- name: Maps
- name: Seo
- name: Serp
- name: Tiktok