Public API

Versioning

How Tradebird versions public API and MCP compatibility.

Tradebird public HTTP APIs are versioned in the URL.

/api/v1

Breaking changes require a new major version. Non-breaking changes may be added to the existing version.

Non-breaking changes

Examples:

  • Adding optional response fields.
  • Adding optional query parameters.
  • Adding new enum values when clients should tolerate unknown values.
  • Adding new endpoints.
  • Adding new MCP tools.

Breaking changes

Examples:

  • Removing a response field.
  • Renaming a response field.
  • Changing a field type.
  • Changing endpoint authentication requirements.
  • Changing required request parameters.

MCP compatibility

The MCP server returns its protocol version during initialize. Public marketplace tools are read-only. Tool response shapes should remain stable enough for agents to parse, and new fields should be treated as additive.

Client guidance

Clients should:

  • Ignore unknown fields.
  • Use canonical URLs from responses.
  • Treat public data as discoverability context, not a final buying decision.
  • Keep user-private requirements outside public API calls unless the user explicitly wants to search with those terms.