Skip to content
Reference

POST /api/v1/refresh

Queues a fresh read of every wallet.

The key is read from PORT_API_KEY, so the command never prints it.

curl -s https://getport.app/api/v1/refresh -X POST -H "Authorization: Bearer $PORT_API_KEY"

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.

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 dataTypeAlways present
queuedintegeryes
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"
]
}

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.

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:

  • 403 refresh_not_allowed when the key was made without refresh.
  • 429 rate_limited when the day's refreshes are spent.