Random US Zip Code Generator

curl --request POST \
  --url https://api.iotools.cloud/v1/tool/random-generator/random-us-zip-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entriesCount": "5",
  "state": "any"
}
'

{
  "outputs": {
    "zipCodes": [
      {
        "zip-code": "<string>",
        "city": "<string>",
        "county": "<string>",
        "state": "<string>"
      }
    ]
  },
  "tool": "<string>",
  "tool_version": "<string>",
  "credits_used": 123,
  "credits_remaining": 123,
  "request_id": "<string>"
}

{
  "type": "https://iotools.cloud/docs/errors/validation_error",
  "title": "Invalid request",
  "status": 400,
  "code": "validation_error",
  "detail": "One or more inputs are invalid — see `fields`.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "fields": {
    "inputString": "Required"
  }
}

{
  "type": "https://iotools.cloud/docs/errors/invalid_api_key",
  "title": "Invalid API key",
  "status": 401,
  "code": "invalid_api_key",
  "detail": "Provide 'Authorization: Bearer <key>'.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://iotools.cloud/docs/errors/insufficient_credits",
  "title": "Insufficient credits",
  "status": 402,
  "code": "insufficient_credits",
  "detail": "This call costs 1 credit and 0 remain in this month's allowance.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0,
  "credits_remaining": 0
}

{
  "type": "https://iotools.cloud/docs/errors/tool_not_allowed",
  "title": "Tool not available over the API",
  "status": 403,
  "code": "tool_not_allowed",
  "detail": "\"Background Remover\" is available on iotools.cloud but has no API endpoint.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://iotools.cloud/docs/errors/tool_not_found",
  "title": "Tool not found",
  "status": 404,
  "code": "tool_not_found",
  "detail": "No tool with that slug. See GET /v1/tools/list.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://iotools.cloud/docs/errors/payload_too_large",
  "title": "Payload too large",
  "status": 413,
  "code": "payload_too_large",
  "detail": "Request body exceeds this tool's size limit.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://iotools.cloud/docs/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Too many requests. Retry in 30s.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "retry_after": 30
}

{
  "type": "https://iotools.cloud/docs/errors/processing_error",
  "title": "Tool failed to run",
  "status": 500,
  "code": "processing_error",
  "detail": "The tool failed to run. Please try again.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0
}

{
  "type": "https://iotools.cloud/docs/errors/tool_disabled",
  "title": "Tool temporarily disabled",
  "status": 503,
  "code": "tool_disabled",
  "detail": "This tool is temporarily unavailable. Try again shortly.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

POST

tool

random-generator

random-us-zip-codes

curl --request POST \
  --url https://api.iotools.cloud/v1/tool/random-generator/random-us-zip-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entriesCount": "5",
  "state": "any"
}
'

{
  "outputs": {
    "zipCodes": [
      {
        "zip-code": "<string>",
        "city": "<string>",
        "county": "<string>",
        "state": "<string>"
      }
    ]
  },
  "tool": "<string>",
  "tool_version": "<string>",
  "credits_used": 123,
  "credits_remaining": 123,
  "request_id": "<string>"
}

{
  "type": "https://iotools.cloud/docs/errors/validation_error",
  "title": "Invalid request",
  "status": 400,
  "code": "validation_error",
  "detail": "One or more inputs are invalid — see `fields`.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "fields": {
    "inputString": "Required"
  }
}

{
  "type": "https://iotools.cloud/docs/errors/invalid_api_key",
  "title": "Invalid API key",
  "status": 401,
  "code": "invalid_api_key",
  "detail": "Provide 'Authorization: Bearer <key>'.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://iotools.cloud/docs/errors/insufficient_credits",
  "title": "Insufficient credits",
  "status": 402,
  "code": "insufficient_credits",
  "detail": "This call costs 1 credit and 0 remain in this month's allowance.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0,
  "credits_remaining": 0
}

{
  "type": "https://iotools.cloud/docs/errors/tool_not_allowed",
  "title": "Tool not available over the API",
  "status": 403,
  "code": "tool_not_allowed",
  "detail": "\"Background Remover\" is available on iotools.cloud but has no API endpoint.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://iotools.cloud/docs/errors/tool_not_found",
  "title": "Tool not found",
  "status": 404,
  "code": "tool_not_found",
  "detail": "No tool with that slug. See GET /v1/tools/list.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://iotools.cloud/docs/errors/payload_too_large",
  "title": "Payload too large",
  "status": 413,
  "code": "payload_too_large",
  "detail": "Request body exceeds this tool's size limit.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://iotools.cloud/docs/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Too many requests. Retry in 30s.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "retry_after": 30
}

{
  "type": "https://iotools.cloud/docs/errors/processing_error",
  "title": "Tool failed to run",
  "status": 500,
  "code": "processing_error",
  "detail": "The tool failed to run. Please try again.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0
}

{
  "type": "https://iotools.cloud/docs/errors/tool_disabled",
  "title": "Tool temporarily disabled",
  "status": 503,
  "code": "tool_disabled",
  "detail": "This tool is temporarily unavailable. Try again shortly.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

entriesCount

number

Count

Required range: 1 <= x <= 40

state

enum<string>

State

Available options:

any,

Alabama,

Alaska,

Arizona,

Arkansas,

California,

Colorado,

Connecticut,

Delaware,

District Of Columbia,

Florida,

Georgia,

Hawaii,

Idaho,

Illinois,

Indiana,

Iowa,

Kansas,

Kentucky,

Louisiana,

Maine,

Maryland,

Massachusetts,

Michigan,

Minnesota,

Mississippi,

Missouri,

Montana,

Nebraska,

Nevada,

New Hampshire,

New Jersey,

New Mexico,

New York,

North Carolina,

North Dakota,

Ohio,

Oklahoma,

Oregon,

Pennsylvania,

Rhode Island,

South Carolina,

South Dakota,

Tennessee,

Texas,

Utah,

Vermont,

Virginia,

Washington,

West Virginia,

Wisconsin,

Wyoming

Response

Tool output

outputs

object

required

Show child attributes

tool

string

required

The tool's slug, echoing the {slug} in the request path.

tool_version

string

required

Output-contract version for this tool.

credits_used

integer

required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining

integer | null

required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id

string

Correlation id, also sent as x-request-id.

Overview

Catalog

Account

Tools

Random US Zip Code Generator

Authorizations

Body

Response