💰

budgets

Budget allocation for a user's spending category. Tracks budgeted amount, actual spending, period, and currency for personal finance and expense management.

🎯 Request Builder

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

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

Endpoints

GET/budgets

Get a collection of budgets

Alternative: /finance/budgets
GET/budgets/:id

Get a single budget by ID

Alternative: /finance/budgets/:id
GET/budgets/meta

Get resource metadata and schema

Alternative: /finance/budgets/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/budgets?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/budgets?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

JavaScript

Fetch Collection
// Get 10 budgets
fetch('https://api.mockly.codes/budgets?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/budgets?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/budgets?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/budgets?nocache=true')

Schema Properties

idinteger

Unique identifier for the budget record

Gen:random_int
user_idinteger

Foreign key reference to the user who owns this budget

Gen:random_int
categorystring

Budget category (e.g., groceries, entertainment, transportation, utilities)

Gen:category
amountnumber

Budgeted amount allocated for this category

Gen:price
spentnumber

Total amount already spent in this category for the current period

Gen:price
periodstring

Budget period (e.g., monthly, weekly, yearly, custom)

Gen:word
currencystring

ISO currency code for budget amounts (e.g., USD, EUR, GBP)

Gen:currency

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