--- title: "eBay Search" method: POST path: "/v1/ebay/search" tags: ["eBay"] --- # eBay Search `POST /v1/ebay/search` ## Request - Base URL: `https://api.prismcrawl.com` - URL: `https://api.prismcrawl.com/v1/ebay/search` - Auth: API key in header `x-api-key` Retrieve native eBay Search data. ## Request body - CatalogEbayRequest: Retrieve native eBay Search data. - `query` string: Text to search for on the selected service. At most 8,192 UTF-8 bytes. - `page` integer: One-based page number. - `device` 'desktop' | 'mobile' | 'tablet': Device presentation for the source request. - `html` boolean: Return the encoded original response rather than parsed JSON. - `zero_trace` boolean: Do not archive source or parsed response artifacts. - `ebay_domain` 'ebay.com.au' | 'ebay.at' | 'ebay.ca' | 'ebay.fr' | 'ebay.de' | 'ebay.com.hk' | 'ebay.ie' | 'ebay.it' | 'ebay.com.my' | 'ebay.nl' | 'ebay.pl' | 'ebay.com.sg' | 'ebay.es' | 'ebay.ch' | 'ebay.co.uk' | 'ebay.com': Regional eBay marketplace domain. Defaults to ebay.com. - `_salic` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 104 | 105 | 106 | 107 | 108 | 109 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 189 | 190 | 191 | 192 | 193 | 194 | 196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 223 | 224 | 226 | 227 | 228 | 229: Country in which listed items are located. - `_ipg` 25 | 50 | 100 | 200: Requested source results per page; limit still caps returned rows. - `_blrs` 'spell_auto_correct': Suppress automatic spelling correction when eBay has exact-query results. - `show_only` string: Comma-separated eBay listing filters, including free shipping and returns. - `buying_format` 'Auction' | 'BIN' | 'BO': Buying format. - `_sasl` string: Comma-separated public seller usernames. - `_saslop` 1 | 2: Include (1) or exclude (2) the specified sellers. - `popular_filters` string: Item-specific attributes as URL-encoded key=value pairs separated by &; multiple values use |. Request controls cannot be overridden. - `_udlo` number: Minimum item price. - `_udhi` number: Maximum item price. - `_sop` 12 | 1 | 10 | 15 | 16 | 7 | 3 | 2 | 18 | 19: Native sort order. Some orders are unavailable on specific domains. - `_dmd` 'Grid' | 'List': Result layout. - `category_id` string: Numeric category ID; may be used without query. - `_stpos` string: ZIP or postal code for delivery and distance filters. - `LH_ItemCondition` string: Pipe-separated native item condition IDs. - `LH_PrefLoc` 'Domestic' | 'Regional' | 'Worldwide': Preferred item location. - `output` 'json' | 'html' | 'md' | 'null', nullable: Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format. - `json_restrictor` string, nullable: Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result. - `no_cache` boolean, nullable: Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies. ## Response `200` Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors. - CatalogEbayResponse - `success` true, required - `request_id` string, uuid, required - `data` union, required - MarkdownSearchData - `format` union, required - '' - 'md' - `content` string, required: Markdown derived from the parsed result, after any json_restrictor selection. - ProjectedSearchData - `format` union, required - '' - 'json' - `content` object, required: Only fields selected by json_restrictor. Selected fields retain their declared types and zero defaults. - object - `format` 'json', required - `content` object, required - `has_next_page` boolean, required - `next_page_token` string, required: Opaque continuation token valid for one hour and the same account. Retain search parameters, device, and result limit. Restart pagination if the token is expired or rejected; tokens from before the authenticated-token rollout cannot be reused. - `results` object[], required - `address` union, required - string - object - string[] - `category` string, required - `condition` string, required - `coordinates` object, required - `latitude` number, required - `longitude` number, required - `description` string, required - `id` string, required - `latitude` number, required - `longitude` number, required - `name` string, required - `phone` string, required - `position` integer, required - `price` string, required - `rank` integer, required - `rating` union, required - number - string - `rating_max` number, required - `rating_source` string, required - `review_count` union, required - number - string - `shipping` string, required - `snippet` string, required - `thumbnail` string, required - `title` string, required - `type` string, required - `url` string, required - `website` string, required - `search_parameters` object, required - `LH_ItemCondition` string, required - `LH_PrefLoc` string, required - `_blrs` string, required - `_dmd` string, required - `_ipg` integer, required - `_salic` integer, required - `_sasl` string, required - `_saslop` integer, required - `_sop` integer, required - `_stpos` string, required - `_udhi` number, required - `_udlo` number, required - `buying_format` string, required - `category_id` string, required - `device` string, required - `ebay_domain` string, required - `engine` string, required - `operation` string, required - `page` integer, required - `pagination_limited` boolean, required: True when further pagination is unavailable. A completed source-stale request can contain verified results or an empty array; next_page_token is an empty string. - `pagination_reason` string, required: stale_cursor means a valid continuation was fetched but its source inventory changed. The HTTP 200 response is billable; keep any verified results and restart pagination. - `popular_filters` string, required - `query` string, required - `show_only` string, required - `type` string, required - `serp_features` object[], required - `confidence` number, required - `engine` string, required - `extracted_at` string, required - `id` string, required - `items` object[], required - `link` string, required - `product_id` string, required - `text` string, required - `thumbnail` string, required - `title` string, required - `links` object[], required - `title` string, required - `url` string, required - `position` object, required - `absolute` integer, required - `source_result_ids` string[], required - `text` string, required - `title` string, required - `type` string, required - GoogleHtmlSearchData - `format` union, required - '' - 'html+br+base64' - `content` string, byte, required: Base64-encoded bytes. Decode Base64 first, then decompress the result with Brotli. Available deferred or lazy-loaded thumbnail sources are placed in image src attributes, within size limits; image and video files are not downloaded. When rewrite_links is true, already-resolved opaque Google anchor links use their destination URLs. Unresolved links are preserved. ## Other responses - `400`: The JSON body, source selection, or continuation is invalid. Locally malformed, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. A source may also reject an otherwise well-formed selector after acquisition. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead. - `401`: The API token is missing, invalid, expired, or revoked. - `402`: No credits remain. - `429`: Account rate limit exceeded. - `500`: The request could not be completed. --- [API](https://skmtc.dev/prismcrawl/apis/prismcrawl-api.md) · [All operations](https://skmtc.dev/prismcrawl/apis/prismcrawl-api/llms.txt) · [OpenAPI document](https://skmtc.dev/prismcrawl/apis/prismcrawl-api/revisions/eef17f6c02a5?raw)