Using the uBuyFirst API for Keywords and Filters
Keyword & Filter API — Help Center Guide #
Programmatic Management of eBay Search Keywords and Item Filters
Table of Contents
1. Overview
Overview #
The uBuyFirst API lets you programmatically manage your eBay search keywords and item filters from outside the app. If your buying conditions change frequently—based on inventory levels, market data, or signals from another system—the API gives you a way to keep uBuyFirst in sync without manual updates.
What You Can Use It For #
The API is built around two core areas: keyword management and filter management. Here are the most common reasons customers use it:
Key Use Cases #
Responding to changing conditions.
If you run another tool or data source that tracks pricing trends, inventory availability, or competitor activity, you can use the API to automatically update your keywords and filters based on what that system tells you—daily, hourly, or at whatever interval makes sense for your operation.
Enabling and disabling keywords on demand.
Rather than deleting a keyword entirely, you can programmatically enable or disable specific search terms. This is useful if you run seasonal searches, rotate categories, or want to pause a keyword when certain conditions aren’t met.
Adjusting price filters dynamically.
Your target price range doesn’t always stay the same. The API lets you update price minimums and maximums across your saved searches without opening the app.
Adding or updating search terms.
You can push new keywords into uBuyFirst from an external source and keep your search library current as your buying criteria evolve. This includes monitoring specific item numbers—useful when you’re tracking relisted inventory that carries a known ID and you want uBuyFirst to catch it the moment it goes live.
Taking automated actions on results.
Filters in uBuyFirst control what happens when a listing matches your criteria—hiding certain results, tagging them for review, or routing them to a specific location. With the API, those filter rules can be updated from an external system as your decision logic changes.
Migrating or backing up your configuration.
The API supports full import and export of both keywords and filters in JSON format, making it straightforward to back up your setup, restore it, or move it between accounts.
Keyword Management #
Through the API, you can:
• Export all of your saved searches as a snapshot you can store, version, or use as a starting point for updates
• Import a set of search terms in bulk, including their settings for price range, marketplace, listing type, condition, category, and seller rules
• Enable or disable individual searches without deleting them
• Organize imported searches into folder structures automatically
Filter Management #
Filters determine what uBuyFirst does when a listing matches your search. Through the API, you can:
• Export your current filter library as a backup or for use in another environment
• Import filters in bulk, including the rules and actions associated with each one
• Apply different actions per filter—such as hiding a result, tagging it with a color, or restricting by country—based on logic you define externally
• Set scope so a filter applies globally across all searches or only to specific ones
Getting Started #
To use the API, generate an API key from the API section under Account Settings. For complete technical details—including endpoint references, request formats, field definitions, and response structures—visit the full API documentation.
