Example
Section titled “Example”The key is read from PORT_API_KEY, so the command never prints it.
Needs a key made with refresh allowed, or it answers 403 refresh_not_allowed. Counts against your plan's refreshes a day (3 a day on Pro+ and Ultra), and answers 202 with how many wallets were queued.
Response
Section titled “Response”A 202 with the envelope every endpoint answers, and this endpoint's answer in data. Amounts and USD figures are strings.
What data looks like, with sample values: the shape is the schema's, checked when these pages are built, and the figures are made up, not anyone's port.
{ "queued": 14}Field of data | Type | Always present |
|---|---|---|
queued | integer | yes |
The whole schema of data
As the OpenAPI document at https://getport.app/api/v1/openapi.json states it. Objects are left open, because a response only ever gains fields.
{ "type": "object", "properties": { "queued": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "queued" ]}From an agent
Section titled “From an agent”The MCP tool port_refresh answers the same question ("read my wallets again now") with the same figures, over the MCP server. It is only listed for a key made with refresh, or an app you let refresh on the Allow page.
Refusals
Section titled “Refusals”Every endpoint shares three: 401 for a missing or dead key, 402 for an account whose plan has no API ("Agents, MCP and the API are on Pro+ and above."), and 429 past the minute or day limit. The errors section has each body.
This endpoint also refuses:
403refresh_not_allowedwhen the key was made without refresh.429rate_limitedwhen the day's refreshes are spent.