regions

location

Geographic region or area within a country with name, country association, description, and area measurements. Used for administrative divisions, geographic classification, and regional data.

Request Builder

https://api.mockly.codes/regions?page=1&limit=10&count=10

Configure your request and click Send Request to see the response here.

Endpoints

GET/regions

Get a collection of regions

Alternative: /location/regions
GET/regions/:id

Get a single region by ID

Alternative: /location/regions/:id
GET/regions/meta

Get resource metadata and schema

Alternative: /location/regions/meta

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/regions?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/regions?q=laptop&search_fields=name,description

Pro Tips

  • Search is case-insensitive and performs partial matching
  • Without search_fields, all text fields are searched
  • Combine with pagination to handle large result sets efficiently

Code Examples

curl "https://api.mockly.codes/regions?page=1&limit=10&count=10"

Examples reflect your current request builder settings.

Schema Properties

idinteger

Unique identifier for the region

Gen:random_int
namestring

Name of the region (e.g., California, Bavaria, Tuscany)

Gen:word
countrystring

Country where this region is located

Gen:country
descriptionstring

Description of the region's characteristics, geography, or significance

Gen:paragraph
areanumber

Total area of the region in square kilometers

Gen:float

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request