explore
Search the X API catalog to find endpoints, parameters, and response shapes before making live requests.
Instructions
The live Xquik 'explore' tool searches the 120-route API catalog. This package stub returns setup guidance only.
When to use
Call 'explore' before 'xquik' to find an endpoint, its parameters, and its response shape.
Call it when the user asks what the Twitter API supports.
Check whether an endpoint uses included usage or requires account access.
When not to use
Use 'xquik' instead when fetching live X data.
Skip discovery when you know the endpoint and parameters.
Behavior
The live server searches the catalog without sending an API request.
The package stub makes no network call and returns setup instructions.
The live catalog has 120 routes. Of these, 119 support JSON or text.
Each EndpointInfo contains method, path, summary, category, free, parameters, and responseShape.
Input format
Provide a bounded request function. Filter, search, or return the spec.endpoints EndpointInfo array.
Examples
Find all included-usage endpoints: async () => spec.endpoints.filter(e => e.free)
Filter by category: async () => spec.endpoints.filter(e => e.category === 'composition')
Search summaries: async () => spec.endpoints.filter(e => e.summary.toLowerCase().includes('tweet'))
Get one endpoint: async () => spec.endpoints.find(e => e.path === '/api/v1/x/tweets/search')
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | Bounded function that filters or searches the spec.endpoints EndpointInfo array. Return one EndpointInfo object or an array. Example: async () => spec.endpoints.filter(e => e.category === 'twitter') |