{
  "aid": "prosperstack.com:main-v1",
  "name": "ProsperStack API Reference",
  "type": "Index",
  "description": "This is the reference documentation for the ProsperStack API v1. Visit ProsperStack at [prosperstack.com](https://prosperstack.com).\n\nFor more information on ProsperStack features, see the [primary documentation](https://prosperstack.com/docs/).\n\nLet us know how we can improve the API, documentation or anything else you need help with at [support@prosperstack.com](mailto:support@prosperstack.com).\n\n# Introduction\n\nThe ProsperStack API provides a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-like interface to your ProsperStack data. It uses standard HTTP verbs, accepts JSON-encoded request bodies and provides JSON-encoded responses.\n\nYou can use the ProsperStack API to access your live production data or data from [test mode](https://prosperstack.com/docs/test-mode/). The API key you use to authenticate requests determines which mode will be used.\n\n# Authentication\n\nThe ProsperStack API uses API keys to authenticate requests. You can manage your API keys from the [ProsperStack API Keys settings page](https://app.prosperstack.com/settings/api-keys).\n\nLive mode API keys have the prefix `key_` and test mode API keys have the prefix `key_test_`.\n\nAuthentication uses [HTTP basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). Provide your API key as the basic authentication username. You don't need to provide a password.\n\nA simple example using cURL:\n\n```bash\ncurl https://api.prosperstack.com/v1/flow_sessions \\\n-u key_LSdJXBrN3SP7bdJrQSMp2eZK:\n```\n\n[Learn more about creating API keys.](https://prosperstack.com/docs/api/)\n\n# Pagination\n\nAll list endpoints support cursor-based pagination. The body of a list response will contain a `data` property with an array of objects and a `next_cursor` property desginating the cursor value to retrieve the next set of results.\n\nUse the value of `next_cursor` in the `cursor` query parameter to specify the set of results to return. If `next_cursor` is `null`, there are no more results.\n\nYou can also specify a `limit` in the query parameters to adjust the number of items per result set. The limit defaults to 10 and has a maximum of 100.\n\n# Rate limits\n\nThe ProsperStack API enforces a rate limit of 100 requests per minute. Your live mode and test mode accounts have separate limits.\n\nWhen the rate limit is exceeded, requests will fail with the HTTP status `429 Too Many Requests` until the limit window resets.\n\nThe ProsperStack API implements the [RateLimit Header Fields for HTTP draft](https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-ratelimit-headers) which describes a set of HTTP headers you can use to observe current request limits.\n\nThe headers are:\n\n- `RateLimit-Limit` — The limit of requests per time window (1 minute)\n- `RateLimit-Remaining` — The number of requests left before exceeding the limit\n- `RateLimit-Reset` — The number of seconds until the limit window resets\n\nIf you need to exceed the rate limit, let us know at [support@prosperstack.com](mailto:support@prosperstack.com) and we'll be happy to help.\n",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/prosperstack.com/main/v1/apis.json",
  "tags": [
    "prosperstack.com",
    "main"
  ],
  "created": "2026-04-11",
  "modified": "2026-04-11",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "prosperstack.com:main-v1",
      "name": "ProsperStack API Reference",
      "description": "This is the reference documentation for the ProsperStack API v1. Visit ProsperStack at [prosperstack.com](https://prosperstack.com).\n\nFor more information on ProsperStack features, see the [primary documentation](https://prosperstack.com/docs/).\n\nLet us know how we can improve the API, documentation or anything else you need help with at [support@prosperstack.com](mailto:support@prosperstack.com).\n\n# Introduction\n\nThe ProsperStack API provides a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-like interface to your ProsperStack data. It uses standard HTTP verbs, accepts JSON-encoded request bodies and provides JSON-encoded responses.\n\nYou can use the ProsperStack API to access your live production data or data from [test mode](https://prosperstack.com/docs/test-mode/). The API key you use to authenticate requests determines which mode will be used.\n\n# Authentication\n\nThe ProsperStack API uses API keys to authenticate requests. You can manage your API keys from the [ProsperStack API Keys settings page](https://app.prosperstack.com/settings/api-keys).\n\nLive mode API keys have the prefix `key_` and test mode API keys have the prefix `key_test_`.\n\nAuthentication uses [HTTP basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). Provide your API key as the basic authentication username. You don't need to provide a password.\n\nA simple example using cURL:\n\n```bash\ncurl https://api.prosperstack.com/v1/flow_sessions \\\n-u key_LSdJXBrN3SP7bdJrQSMp2eZK:\n```\n\n[Learn more about creating API keys.](https://prosperstack.com/docs/api/)\n\n# Pagination\n\nAll list endpoints support cursor-based pagination. The body of a list response will contain a `data` property with an array of objects and a `next_cursor` property desginating the cursor value to retrieve the next set of results.\n\nUse the value of `next_cursor` in the `cursor` query parameter to specify the set of results to return. If `next_cursor` is `null`, there are no more results.\n\nYou can also specify a `limit` in the query parameters to adjust the number of items per result set. The limit defaults to 10 and has a maximum of 100.\n\n# Rate limits\n\nThe ProsperStack API enforces a rate limit of 100 requests per minute. Your live mode and test mode accounts have separate limits.\n\nWhen the rate limit is exceeded, requests will fail with the HTTP status `429 Too Many Requests` until the limit window resets.\n\nThe ProsperStack API implements the [RateLimit Header Fields for HTTP draft](https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-ratelimit-headers) which describes a set of HTTP headers you can use to observe current request limits.\n\nThe headers are:\n\n- `RateLimit-Limit` — The limit of requests per time window (1 minute)\n- `RateLimit-Remaining` — The number of requests left before exceeding the limit\n- `RateLimit-Reset` — The number of seconds until the limit window resets\n\nIf you need to exceed the rate limit, let us know at [support@prosperstack.com](mailto:support@prosperstack.com) and we'll be happy to help.\n",
      "image": "https://prosperstack.com/images/logo-api.svg",
      "baseURL": "https://api.prosperstack.com/v1",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/prosperstack.com/main/v1",
      "version": "v1",
      "tags": [
        "prosperstack.com",
        "main"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/prosperstack.com/main/v1/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/prosperstack.com/main/v1"
        }
      ]
    }
  ]
}