Skip to main content

​
Standard Request Template

curl --request GET \
  --url "$FLOPPY_BASE_URL/v1/rotating/statistics?proxyType=residential" \
  --header "X-Api-Key: $FLOPPY_API_KEY"

​
Useful Tooling

  • curl for API calls
  • jq for formatting JSON responses
  • your HTTP client of choice (Postman, Insomnia, Bruno)
Example with jq: 
curl --silent \
  --url "$FLOPPY_BASE_URL/v1/static/list" \
  --header "X-Api-Key: $FLOPPY_API_KEY" | jq

​
Handling Responses

  • Most endpoints return 200 on success.
  • POST /v1/tools/checkProxy may return 400 (proxy validation failed) or 402 (no traffic available).

​
OpenAPI Source

The API reference is generated from:
  • https://client-api.floppy.host/v1/openapi.json
  • local copy: /api-reference/openapi.json