- Projects are built in the ParseHub desktop app. The API lists, runs and reads projects; it cannot create or edit them.
- A run is asynchronous.
projects.runreturns the new run straight away. Pollruns.getuntildata_readyis true orstatusiscancelledorerror(ParseHub allows 25 polls in a run’s first 5 minutes, then one every 3 minutes). A cancelled or failed run may have no data; whendata_readyis true, callruns.getData.projects.getLastReadyDataskips the polling and returns the newest finished data. - Data comes as JSON or CSV.
format: 'csv'returns the CSV as a string. - The key is the
api_keyparameter. The client sends it in the query string on every call, where Corsair redacts it from errors. With no key stored, Corsair raisesAuthMissingErrorbefore any request; a key ParseHub rejects comes back as HTTP 401. - Limits. 5 requests a second (up to 25 queued);
projects.listreturns at most 20 projects per page.
- 8 typed API operations
- 1 synced entity (
projects) for fast.search()/.list()
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the ParseHub API key before the first call: More: API Key
pnpm corsair setup --plugin=parsehub --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
Get the latest scraped data of a projectQuery synced data
Synced entities supporttenant.parsehub.db.<entity>.search() and .list(): projects.
See Database for filters and operators.
What’s next
API reference
Every
parsehub.api.* operation with input and output types.Database
Synced entities, search filters, and operators.
Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.