SearchCtrl+K

GeoDB APIs›Flags API

Flags API Reference

Retrieve country and international organization flag images in PNG, WEBP, or SVG format with flat or round shapes in five size options.

GET

https://api.apifreaks.com/v1.0/flags

Test

Returns a binary flag image. The name, type, and shape parameters are required.

Getting Started

Authentication

Pass your API key as the apiKey parameter in every request.

API Version

This is version v1.0 of the API.

API Request

Query Parameters

The name, type, and shape parameters are required. format and size are optional.

namerequiredString

Country code in ISO 3166-1 alpha-2 format for country flags, or organization identifier for organization flags. Example: US, GB, PK.

typerequiredString

Type of flag to retrieve. Available values: country, organization.

shaperequiredString

Shape of the flag image. Available values: flat, round.

formatoptionalStringdefault: png

Image format. Available values: png, webp, svg.

sizeoptionalStringdefault: 64px

Size of the flag image in pixels. Available values: 16px, 24px, 32px, 48px, 64px. Applicable to PNG and WEBP formats only.

API Response Schema

A successful request returns a 200 OK response with binary image data. The Content-Type header reflects the requested format (image/png, image/webp, or image/svg+xml).

(binary)

Binarymandatory

The flag image returned as binary data in the specified format (PNG, WEBP, or SVG). The Content-Type header reflects the format (image/png, image/webp, image/svg+xml).

Error Status & Codes

The API uses standard HTTP status codes to indicate the success or failure of requests. For details about supported status codes and error responses, refer to the HTTP Error Codes.

404

Invalid country name or code.