Metadapi Technical Blog

API Testing Tools: Which Tool Should You Use at Each Stage of the API Development Lifecycle?

Sat, 05 Sep 2026 15:59:00 GMT

Building a reliable API requires much more than sending a few HTTP requests and checking whether a 200 OK response comes back. Modern APIs need to be tested throughout their entire lifecycle—from the initial API contract through development, integration, automated regression testing, performance testing, security testing, and production monitoring.

Fortunately, there are many excellent API testing tools available. Unfortunately, this abundance of options can make choosing the right tool confusing.

The most important thing to understand is that there is no single API testing tool that is perfect for every situation. A developer manually debugging an endpoint has different needs than a QA engineer building regression tests. Likewise, a performance engineer testing thousands of concurrent API requests needs a completely different type of tool.

This article reviews some of the most popular API testing tools and explains where each one fits into the API development lifecycle.

The API Testing Lifecycle

Before looking at individual tools, it helps to divide API testing into several stages:

API Design and Contract Validation
Developer Exploratory Testing
Functional and Integration Testing
Automated Regression Testing
Performance and Load Testing
Security Testing
CI/CD Pipeline Testing
Production Monitoring

Some tools cover multiple stages, while others are highly specialized. The best API teams typically use a combination of tools rather than forcing one tool to solve every testing problem.

Quick Comparison of API Testing Tools

Tool	Best For	Lifecycle Stage	Learning Curve
Postman	General API development and collaboration	Development through CI/CD	Easy
Insomnia	Fast exploratory API testing	Development	Easy
Bruno	Git-native API testing	Development and automated testing	Easy
SoapUI	SOAP and enterprise API testing	Functional and regression testing	Moderate
REST Assured	Code-based API automation	Automated regression and CI/CD	Moderate
Karate	Behavior-driven API testing	Automation and regression testing	Moderate
Apache JMeter	Load and performance testing	Performance testing	Moderate
k6	Developer-friendly performance testing	Performance and CI/CD	Moderate
Katalon	Unified API and UI testing	QA automation lifecycle	Easy to Moderate
OWASP ZAP	API security testing	Security testing	Moderate
Datadog Synthetic Monitoring	Production API validation	Production Monitoring	Easy
New Relic Synthetics	API availability and workflow monitoring	Production Monitoring	Easy
Postman Monitors	Continuous execution of API tests	Production Monitoring / CI-CD	Easy to Moderate

1. Postman

Website: https://www.postman.com/

Best For

General-purpose API development, exploratory testing, functional testing, collaboration, and automated API testing.

Where It Fits in the API Lifecycle

Postman is one of the most versatile tools in the API ecosystem. It can be used from the earliest stages of API development through automated testing and CI/CD pipelines.

A typical developer workflow might look like this:

Create or import an OpenAPI specification.
Build individual requests to test endpoints.
Create collections representing API workflows.
Add automated assertions.
Configure environments for development, staging, and production.
Run collections automatically in CI/CD pipelines

Review

Postman has evolved from a simple HTTP client into a comprehensive API platform. Its biggest strength is breadth: developers can design APIs, create mock servers, manually test endpoints, build automated tests, manage environments, document APIs, and integrate tests into CI/CD workflows from a single ecosystem.

It is particularly useful for teams because collections provide a common way to document and test API behavior. A well-designed Postman collection can serve as both executable tests and living API examples.

The downside is that Postman can feel heavyweight if all you need is a quick HTTP request. Its growing feature set also means that some developers prefer simpler, local-first alternatives.

Recommendation: If you need one versatile tool for general API development and testing, Postman remains an excellent starting point.

2. Insomnia

Website: https://insomnia.rest/

Best For

Fast exploratory testing, debugging APIs, and developers who prefer a simpler API client experience.

Where It Fits in the API Lifecycle

Insomnia is most useful during active API development. It is particularly well suited for the question:

"I just changed this endpoint. Let me quickly send some requests and see what happens."

Review

Insomnia provides a clean and developer-focused interface for working with APIs. It supports modern API technologies including REST, GraphQL, gRPC, and WebSocket-based workflows.

Compared with larger API platforms, Insomnia tends to feel more focused on the developer's immediate workflow: creating requests, managing authentication, testing responses, and debugging services.

Its main limitation is that organizations looking for a complete API lifecycle platform—including extensive documentation, governance, monitoring, and enterprise collaboration—may eventually need additional tooling.

Recommendation: Excellent for developers who want a fast, focused tool primarily for exploring and debugging APIs.

3. Bruno

Website: https://www.usebruno.com/

Best For

Developers and teams that want API collections stored locally and managed through Git.

Where It Fits in the API Lifecycle

Bruno fits particularly well into a modern Git-based development workflow. API test definitions can live directly alongside application source code.

This makes it useful during:

Local development
Code reviews
Automated regression testing
CI/CD pipelines

Review

Bruno has gained popularity because of its local-first and Git-native philosophy. Rather than making a cloud workspace the center of collaboration, Bruno stores collections as files that can be committed to source control.

This approach has significant advantages for software engineering teams. API requests and tests can be versioned alongside the code that implements the API. Pull requests can show changes to both the API implementation and its corresponding tests.

Bruno is especially attractive for teams concerned about privacy, vendor lock-in, or keeping development artifacts entirely under source control.

The tradeoff is that it may not offer the same level of enterprise collaboration and ecosystem features found in larger API platforms.

Recommendation: One of the best choices for engineering teams that follow a Git-first workflow.

4. SoapUI

Website: https://www.soapui.org/

Best For

Enterprise APIs, especially environments that still use SOAP services alongside REST APIs.

Where It Fits in the API Lifecycle

SoapUI is particularly useful for:

Functional testing
Regression testing
Complex multi-step workflows
SOAP service testing
Mocking and service virtualization

Review

SoapUI has been a major API testing tool for many years and remains particularly relevant in enterprise environments. Its strongest differentiator is deep support for SOAP and WSDL-based services while also supporting REST and other API technologies.

It provides capabilities beyond simply sending HTTP requests. Test cases can contain multiple steps, assertions, data handling, scripting, and workflow logic.

For organizations working primarily with modern REST APIs, the interface may feel heavier than newer tools. However, for organizations supporting legacy enterprise integrations, financial systems, telecom systems, or large SOAP environments, SoapUI remains highly relevant.

Recommendation: Strong choice for enterprise environments, particularly where SOAP is still an important part of the architecture.

5. REST Assured

Website: https://rest-assured.io/

Best For

Developers building automated API tests directly in Java code.

Where It Fits in the API Lifecycle

REST Assured is most valuable during automated testing and CI/CD integration.

Unlike graphical API clients, REST Assured allows API tests to become part of the application's source code and automated test suite.

Review

REST Assured is a Java library designed specifically for testing REST APIs. Its fluent syntax makes API tests relatively easy to read.


given()
.header("Authorization", "Bearer token")
.when()
.get("/users/123")
.then()
.statusCode(200)
.body("name", equalTo("John"));

The major advantage of REST Assured is that developers can apply normal software engineering practices to API tests. Tests can be version-controlled, refactored, reviewed, and executed alongside unit and integration tests.

Its biggest limitation is accessibility. Non-technical QA users may find a graphical tool easier than writing Java code.

Recommendation: Excellent for Java engineering teams that want API testing tightly integrated into their automated test suites.

6. Karate

Website: https://docs.karatelabs.io/

Best For

Behavior-driven API testing and teams that want readable automated tests without writing large amounts of traditional programming code.

Where It Fits in the API Lifecycle

Karate is primarily useful for:

Automated functional testing
Regression testing
Integration testing
CI/CD pipelines

Review

Karate uses a readable, behavior-driven syntax that makes API tests understandable by both developers and QA professionals.

A test might describe an API interaction in a format closer to natural language than traditional code. This can improve collaboration between technical and QA teams.

Karate is especially useful when API testing becomes a significant part of an automated quality assurance strategy. It provides a balance between graphical testing tools and fully code-based frameworks.

Recommendation: A good choice for teams that want maintainable, readable automated API tests using a behavior-driven approach.

7. Apache JMeter

Website: https://jmeter.apache.org/

Best For

Load testing, stress testing, and performance testing APIs.

Where It Fits in the API Lifecycle

JMeter should generally be introduced after functional testing has established that the API behaves correctly.

Typical questions JMeter can help answer include:

Can the API handle 1,000 concurrent users?
How does response time change under load?
Where does the system begin to fail?
How many requests per second can the API sustain?
Does performance degrade during extended usage?

Review

Apache JMeter is one of the most established open-source performance testing tools. It can simulate significant workloads and provides detailed controls for designing test scenarios.

Its flexibility is also one of its challenges. Complex JMeter test plans can become difficult to maintain, and the graphical interface can feel intimidating to developers unfamiliar with performance testing concepts.

Recommendation: A strong choice for dedicated performance testing, especially for teams already familiar with traditional QA and load-testing workflows.

8. k6

Website: https://k6.io/

Best For

Developer-friendly API performance testing and automated performance testing in CI/CD pipelines.

Where It Fits in the API Lifecycle

k6 is particularly valuable during:

Performance testing
Pre-release validation
CI/CD performance regression testing
Capacity planning

Review

k6 approaches performance testing with a developer-centric philosophy. Tests are written as scripts, making them easier to version-control and integrate into automated pipelines.

This makes k6 particularly attractive for DevOps and platform engineering teams that want performance testing to become part of the software delivery process rather than a separate manual QA activity.

For example, a CI/CD pipeline could automatically reject a release if API response times exceed an established threshold under a predefined workload.

Recommendation: One of the strongest choices for teams adopting "performance testing as code."

9. Katalon

Website: https://katalon.com/

Best For

QA teams that need to test APIs alongside web and mobile applications.

Where It Fits in the API Lifecycle

Katalon fits particularly well into a broader automated testing strategy where APIs are only one component of the application.

It can be used for:

API functional testing
Automated regression testing
End-to-end testing
API and UI integration testing
CI/CD automation

Review

Katalon's primary advantage is that it provides a unified testing platform. Rather than maintaining separate frameworks for API testing, browser testing, and mobile testing, teams can consolidate multiple testing activities.

Its low-code capabilities can also make automated testing more accessible to QA professionals who are not full-time software developers.

The tradeoff is that specialized developers may prefer lighter tools focused exclusively on APIs.

Recommendation: Particularly useful for QA organizations that need API testing to be part of a larger end-to-end automation strategy.

10. OWASP ZAP

Website: https://www.zaproxy.org/

Best For

Security testing APIs and identifying common security vulnerabilities.

Where It Fits in the API Lifecycle

Security testing should not be reserved for the final stage before production. Ideally, automated security testing should be incorporated into development and CI/CD processes.

Review

OWASP ZAP is an open-source security testing tool that can help identify common vulnerabilities in web applications and APIs.

It is particularly useful for detecting issues related to insecure configurations, authentication, exposed endpoints, and other common security weaknesses.

However, automated security scanners should not be considered a replacement for professional security testing. They are excellent for identifying known patterns and common vulnerabilities but cannot understand every business-specific security risk.

Recommendation: A valuable addition to an API security testing strategy, especially when integrated into automated pipelines.

11. Datadog Synthetic Monitoring

Website: https://www.datadoghq.com/product/synthetic-monitoring/

Best For

Continuously testing production APIs to verify availability, functionality, response times, and critical workflows from outside the application.

Where It Fits in the API Lifecycle

Datadog Synthetic Monitoring fits primarily into the production monitoring and operations stage of the API lifecycle.

Unlike traditional API testing tools that are primarily used during development or before deployment, synthetic monitoring continuously tests an API after it has been deployed.

A typical production monitoring workflow might involve running automated tests every few minutes against critical API endpoints. These tests can validate much more than simple availability.

Is the API endpoint reachable?
Is the API returning the expected HTTP status code?
Is the response time within an acceptable threshold?
Does the response contain the expected data?
Is authentication functioning correctly?
Are critical multi-step API workflows functioning?
Is the API behaving correctly from multiple geographic locations?

Review

Datadog Synthetic Monitoring is a strong choice for organizations that want to move beyond traditional infrastructure monitoring and actively test whether their APIs are functioning correctly from the perspective of an external consumer.

This distinction is important. Traditional infrastructure monitoring might tell you that a server is running, CPU utilization is normal, and an application process is healthy. However, none of those signals necessarily guarantee that an API consumer can successfully make a request and receive the expected result.

Synthetic API tests solve this problem by simulating real API requests on a scheduled basis. Tests can validate status codes, response times, headers, response bodies, and other expected behavior.

Datadog also supports more complex multistep API tests. This is useful when validating workflows rather than isolated endpoints. For example, a synthetic test could authenticate a user, retrieve an access token, call a protected endpoint, and validate the resulting response.

Another major advantage is integration with the broader Datadog observability platform. When a synthetic test detects a failure, teams can correlate that failure with infrastructure metrics, application logs, traces, and other monitoring data to help identify the underlying cause.

Datadog Synthetic Monitoring is also useful for APIs with customers distributed geographically. A service may be functioning correctly from the same cloud region where it is hosted while experiencing connectivity or latency problems for customers in another region.

Recommendation: An excellent choice for production API monitoring, particularly for teams already using Datadog for infrastructure, logging, APM, and observability.

12. New Relic Synthetic Monitoring

Website: https://newrelic.com/platform/synthetics

Best For

Proactively monitoring API availability and functionality from public or private locations.

Where It Fits in the API Lifecycle

New Relic Synthetic Monitoring belongs primarily in the production monitoring stage, although it can also be useful for validating staging and pre-production environments.

Review

New Relic's synthetic monitoring capabilities provide another strong option for continuously testing applications and API endpoints. API tests can perform scripted HTTP requests and validate whether endpoints are functioning correctly over time.

One of the key benefits of synthetic monitoring is that it can detect problems even when an API is not receiving significant real-world traffic. Traditional application monitoring depends heavily on observing actual requests. Synthetic monitoring creates its own traffic, ensuring that critical API functionality is tested continuously.

New Relic supports different types of synthetic monitors, ranging from simple availability checks to more sophisticated scripted API tests. Monitoring can also be performed from private locations for applications that are not publicly accessible.

This makes it particularly useful for organizations that operate APIs inside private networks or need to validate internal services.

Recommendation: A strong alternative for organizations using New Relic as their primary observability platform and wanting synthetic API monitoring integrated with their existing telemetry.

13. Postman Monitors

Website: https://www.postman.com/product/monitors/

Best For

Teams that already use Postman for API testing and want to continuously run their existing API collections against staging or production environments.

Where It Fits in the API Lifecycle

Postman Monitors provide an interesting bridge between API testing and production monitoring.

They can be used after deployment to continuously execute existing Postman collections on a schedule.

Review

One of the biggest advantages of Postman Monitors is reuse. Teams that have already created functional API tests in Postman do not necessarily need to recreate those tests in another monitoring platform.

A Postman collection containing requests, assertions, authentication workflows, and response validation can be scheduled to run continuously.

This creates a natural progression through the API lifecycle:

A developer manually tests an endpoint using Postman.
The request becomes part of a collection.
Assertions are added to validate expected behavior.
The collection becomes part of automated regression testing.
The same collection can be monitored continuously after deployment.

Postman Monitors can also validate complete workflows by chaining multiple requests together. This is useful for APIs where simply checking that an endpoint returns a 200 OK response is not sufficient.

For example, a monitor could authenticate with an API, retrieve an access token, perform a search, retrieve a resource, and validate the returned data.

The main limitation compared with a dedicated observability platform is that Postman is primarily an API development platform rather than a complete infrastructure and application observability solution.

Recommendation: An excellent option for teams heavily invested in Postman that want to extend their existing API test collections into continuous monitoring.

Production Monitoring Is Not the Same as Uptime Monitoring

One important distinction when monitoring APIs in production is the difference between uptime monitoring and synthetic API monitoring.

A basic uptime monitor might perform a request such as:

GET /health

And verify that the response is:

HTTP 200 OK

While useful, this does not necessarily prove that the API is functioning correctly for customers.

Consider an API endpoint that returns:

HTTP 200 OK

{
    "data": []
}

The API might technically be online, but a database failure could be causing it to return incorrect or incomplete data.

A properly designed synthetic API test should validate the actual business behavior of the API.

For example, a production synthetic test might verify:

The endpoint responds successfully.
The response time is below 500 milliseconds.
The expected response schema is returned.
Required properties are present.
The returned data contains expected values.
Authentication is functioning correctly.
Rate limiting behaves as expected.

This is why synthetic monitoring should be considered a form of continuous API testing, rather than simply uptime monitoring.

Recommended Production Monitoring Strategy

A mature API platform should consider monitoring multiple levels of functionality.

Monitoring Level	Example Test	Purpose
Availability	Check API health endpoint	Verify the service is reachable
Endpoint Health	Call a critical API endpoint	Verify individual functionality
Response Validation	Validate response schema and data	Detect incorrect responses
Authentication	Authenticate and call protected endpoints	Verify security workflows
Business Workflow	Execute multiple API requests in sequence	Validate critical customer journeys
Performance	Validate response time thresholds	Detect degradation
Geographic Availability	Run tests from multiple locations	Detect regional problems

Where Production Synthetic Monitoring Fits in the Complete API Lifecycle

Production monitoring completes the API testing lifecycle.

Design: Validate the API contract using OpenAPI and specification tools.
Development: Manually test endpoints using tools such as Postman, Insomnia, or Bruno.
Functional Testing: Validate API behavior and workflows.
Regression Testing: Automatically test APIs when code changes.
Performance Testing: Test how APIs behave under load using tools such as k6 or JMeter.
Security Testing: Scan APIs for vulnerabilities.
Deployment: Release the API to production.
Production Synthetic Monitoring: Continuously verify that the deployed API continues functioning correctly.

This final stage is particularly important because deployment is not the end of testing.

Infrastructure changes, certificate expiration, database problems, DNS issues, third-party service failures, configuration changes, and unexpected application regressions can all cause an API to fail after it has successfully passed pre-production testing.

Synthetic monitoring provides an independent and continuous validation layer that answers a simple but critical question:

"If a customer tried to use our API right now, would it actually work?"

Tools such as Datadog Synthetic Monitoring, New Relic Synthetic Monitoring, and Postman Monitors help API teams continuously answer that question.

When Should Each Tool Be Used?

The following is a practical way to think about API testing tools throughout the complete API development lifecycle. The important thing to remember is that API testing does not end when an API is deployed. Different tools address different risks at different stages.

Stage 1: API Design and Contract Validation

Before implementation begins, teams should validate the API contract and ensure that endpoints, request parameters, response models, authentication requirements, and error responses are clearly defined.

Recommended tools:

Postman
Swagger / OpenAPI tools
Stoplight

Goal: Ensure the API contract is clear, consistent, and agreed upon before developers begin implementation.

At this stage, teams should focus on questions such as:

Are endpoint paths logically designed?
Are request and response schemas clearly defined?
Are HTTP status codes used consistently?
Are authentication requirements documented?
Are error responses standardized?

Stage 2: Local Development and Exploratory Testing

During development, developers need a quick way to send requests, inspect responses, troubleshoot authentication, and debug API behavior.

This is the stage where interactive API clients are most valuable.

Recommended tools:

Postman
Insomnia
Bruno
HTTPie or curl

Goal: Quickly verify that individual endpoints behave correctly while they are being developed.

These tools are ideal for questions such as:

Does the endpoint return the expected status code?
Is authentication working?
Does the API return the expected JSON structure?
Are query parameters being processed correctly?
Are error responses working as expected?

Stage 3: Functional and Integration Testing

Once individual endpoints work correctly, the next step is validating complete API functionality and interactions between multiple services.

At this stage, testing should move beyond isolated requests and begin validating workflows.

Recommended tools:

Postman Collections
SoapUI
REST Assured
Karate

Goal: Verify that API endpoints, services, databases, authentication systems, and dependent services work correctly together.

Example workflow:

Authenticate with the API.
Retrieve an access token.
Call a protected endpoint.
Create or retrieve a resource.
Validate the response.
Verify the expected data was persisted or returned.

Stage 4: Automated Regression Testing

Every time an API changes, existing functionality should be tested automatically to detect unintended regressions.

Manual testing alone becomes increasingly difficult as an API grows. Automated regression testing ensures that previously working endpoints continue to function after code, infrastructure, or dependency changes.

Recommended tools:

REST Assured
Karate
Postman CLI
Bruno
Katalon

Goal: Automatically catch breaking changes before they reach production.

Regression tests should validate:

Status codes
Response schemas
Required properties
Business logic
Authentication
Error handling
Backward compatibility

Stage 5: Performance and Load Testing

Once functional correctness has been established, APIs should be tested under realistic workloads.

An API may function perfectly when tested by a single developer but experience failures when thousands of concurrent clients begin making requests.

Recommended tools:

k6
Apache JMeter

Goal: Understand how the API behaves under normal, peak, and extreme workloads.

Performance testing can help answer questions such as:

How many requests per second can the API handle?
How does response time change as traffic increases?
What happens when downstream services become slow?
Where is the application's performance bottleneck?
When does the API begin returning errors?
Can the infrastructure scale as expected?

Stage 6: Security Testing

APIs should be continuously evaluated for security vulnerabilities and configuration problems.

Security testing should not be treated as a single activity performed immediately before release. Ideally, automated security checks should be integrated throughout the development lifecycle.

Recommended tools:

OWASP ZAP
Specialized API security platforms (not reviewed in this article)

Goal: Identify security vulnerabilities before they can affect customers or expose sensitive data.

Stage 7: CI/CD Pipeline Testing

Automated API testing should become part of the software delivery process.

Rather than relying on developers or QA engineers to remember to run tests manually, critical tests should execute automatically when code changes are committed or deployed.

A mature CI/CD pipeline might execute:

Unit tests
API contract validation
Functional API tests
Integration tests
Regression tests
Security scans
Performance smoke tests
Deployment

Recommended tools:

REST Assured
Karate
Postman CLI
Bruno
k6

Goal: Prevent defective API releases from reaching staging or production environments.

Stage 8: Production Monitoring and Continuous API Validation

Deployment should not be considered the end of the API testing lifecycle.

Even after an API has successfully passed functional, regression, performance, and security testing, problems can still occur in production. Infrastructure changes, DNS failures, expired certificates, database problems, third-party dependency failures, configuration changes, and unexpected regressions can all affect a previously functioning API.

Production synthetic monitoring provides a continuous layer of validation by actively executing API requests against the deployed production environment.

Recommended tools:

Datadog Synthetic Monitoring
New Relic Synthetic Monitoring
Postman Monitors

Goal: Continuously verify that customers can successfully use the API in the real production environment.

Production monitoring should go beyond simply checking whether a server responds with HTTP 200 OK.

Effective synthetic API tests can validate:

API availability and reachability
Expected HTTP status codes
Response time thresholds
Response schemas
Required response properties
Expected data values
Authentication workflows
Critical multi-step API workflows
Geographic availability and latency

For example, an API health check might confirm that a service is running:

GET /health

HTTP 200 OK

However, a synthetic production test can validate something much closer to an actual customer interaction:

Authenticate using valid API credentials.
Retrieve an access token.
Call a protected API endpoint.
Validate the response status.
Validate the response schema.
Verify that expected data is returned.
Confirm the response time is within an acceptable threshold.

This distinction is important because an API can appear healthy from an infrastructure perspective while still failing from a customer's perspective.

Production monitoring closes the API testing lifecycle loop. Pre-production testing asks, "Will this API work when deployed?" Production synthetic monitoring continuously asks, "Is this API working right now for our customers?"

The Complete API Testing Lifecycle

When viewed as a complete lifecycle, API testing becomes a continuous process rather than a single QA activity.

Design: Define and validate the API contract.
Development: Manually test and debug individual endpoints.
Functional Testing: Validate API functionality and workflows.
Regression Testing: Automatically detect breaking changes.
Performance Testing: Validate behavior under load.
Security Testing: Identify vulnerabilities and security weaknesses.
CI/CD Testing: Automatically validate releases before deployment.
Production Monitoring: Continuously validate the deployed API from the customer's perspective.

The lifecycle does not truly have an endpoint. Production monitoring can identify issues that lead to new tests, fixes, and improvements, feeding information back into the development process.

This creates a continuous quality loop:

Design → Develop → Test → Deploy → Monitor → Improve

Ultimately, the best API teams do not ask, "Which is the best API testing tool?"

They ask:

"What type of risk are we trying to detect, and what is the best tool to detect it?"

Answering that question at every stage of the API lifecycle leads to a more reliable, secure, and maintainable API.

Why API Testing Is Not Optional (And What You Should Be Doing About It)

Fri, 01 May 2026 00:03:33 GMT

Introduction

APIs sit at the center of modern software. Whether you're building a SaaS platform, a mobile app backend, or a data product, the API is the contract your system exposes to the world. If that contract breaks, everything built on top of it breaks too.

That’s why API testing isn’t just a “nice-to-have”—it’s a foundational part of delivering reliable software.

The Real Reason APIs Need Testing

At a glance, an API might look simple: a few endpoints, some JSON responses, maybe authentication. But under the hood, APIs coordinate multiple moving parts:

Databases
External services
Business logic
Caching layers
Authentication/authorization

Even small changes can introduce subtle failures:

A field gets renamed → clients break
A query slows down → performance degrades
A dependency fails → cascading errors
Edge cases return incorrect data

Without testing, these issues often show up after deployment, when your users are the ones discovering them.

API testing gives you confidence that:

Your endpoints behave as expected
Your system performs under load
Your integrations don’t silently fail
Your changes don’t introduce regressions

Types of API Testing You Should Be Doing

Good API testing isn’t just one thing—it’s a combination of different testing strategies that cover correctness, reliability, and scalability. Let's go over the different types of testing you should be doing:

1. Functional Testing (Does it work?)

This is the baseline. Functional testing verifies that:

Endpoints return the correct status codes
Responses match expected schemas
Business logic behaves correctly

Example:

An API endpoint can receive country code as a parameter. What happens if the parameter is not included ? What happens if the country code is invalid? Does the response format change for different countries ?

👉 Functional testing ensures your API does what it claims to do.

2. Integration Testing (Do systems work together?)

APIs rarely operate in isolation. Integration tests validate:

Database interactions
Third-party API calls
Messaging systems

Example:

Your API sends a log to a logging service. When the API is called/executed, does the message get to the 3rd party logging service ? is the message in the right format? If there is a connection error does the API break?

👉 Integration testing ensures your system works end-to-end, not just in isolation.

3. Performance Testing (How fast is it?)

Performance testing evaluates:

Response times
Throughput (requests per second)
Latency under normal load

Example:

Can your API handle 500 requests per second with <200ms response time?

👉 Performance testing ensures a smooth user experience under expected usage.

4. Stress Testing (What happens when things break?)

Stress testing pushes your API beyond normal limits:

Traffic spikes
Resource exhaustion
Unexpected load patterns

Example:

What happens at 10x normal traffic? Does your API degrade gracefully or crash? Is there a limit in the number of request the API can take ?

👉 Stress testing helps you understand failure boundaries.

5. Load Testing (Can it scale?)

Often confused with performance testing, load testing focuses on:

Sustained traffic over time
Scalability under realistic conditions

What happens when 100 requests per second hit the API? 1K ? 1M ?

👉 Load testing ensures your system holds up during real-world usage (not just bursts).

6. Security Testing (Is it safe?)

APIs are common attack surfaces. Security testing checks:

Authentication & authorization
Rate limiting
Injection vulnerabilities
Data exposure

👉 Security testing protects both your system and your users.

7. Regression Testing (Did you break something?)

Every change introduces risk. Regression testing ensures:

Existing functionality still works
New features don’t break old ones

👉 Regression testing is critical for maintaining stability as your API evolves.

Building a Practical API Testing Strategy

A solid approach doesn’t require dozens of tools—it requires the right combination. In a future article we'll evaluate different testing tools to help build either the minimal must-have testing environment or an enterprise grade testing suite for complex use cases.

The key to testing success is consistency. Testing should happen:

During development
Before deployment
After changes
Continuously in production monitoring

Final Thoughts

APIs are products. And like any product, quality defines success.

Without testing, you’re guessing.

With testing, you’re engineering confidence.

The difference shows up in:

Fewer production issues
Faster development cycles
Better user trust
More scalable systems

If your API is critical to your business (and it probably is), then investing in a proper testing strategy isn’t overhead—it’s leverage.

New Distance Between ZIP Code and Coordinates Endpoint

Mon, 13 Apr 2026 21:31:39 GMT

🚀 Introducing the New Distance Between ZIP Code and Coordinates Endpoint

We’re excited to announce a powerful new addition to the Zip Code API v2: the Distance Between ZIP Code and Latitude/Longitude Coordinates endpoint.

This new capability expands the API’s geospatial intelligence by enabling developers to calculate distances not just between ZIP codes—but between a ZIP code and any geographic point on Earth.

📍 What This Endpoint Does

The new endpoint:

GET/zipc/v2/distancecoord

allows you to calculate the geographic distance between:

A U.S. ZIP Code, and
A pair of latitude and longitude coordinates

This makes it easy to bridge traditional postal geography with real-world geospatial coordinates.

Key Capabilities

Returns distance in miles and kilometers
Accepts any valid latitude/longitude pair
Uses precise geographic calculations for accurate results
Fully integrated into the Zip Code API v2 ecosystem

This endpoint complements the existing `/distance` endpoint (ZIP-to-ZIP) by enabling ZIP-to-point distance calculations, significantly expanding use cases.

💡 Why This Matters

Traditionally, developers had to:

Convert ZIP codes into coordinates
Apply formulas like Haversine manually
Handle edge cases and accuracy issues

Now, this endpoint simplifies everything into a single API call, eliminating the need for custom geospatial logic.

🧠 Sample Use Cases

Here are some practical ways to leverage this new endpoint:

1. 📦 Logistics & Delivery Optimization

Calculate distance from a warehouse (ZIP code) to a delivery location (coordinates)
Assign nearest distribution center dynamically

2. 📍 Location-Based Services

Determine proximity of a user’s GPS location to a service area defined by ZIP code
Power “nearest location” features in apps

3. 🎯 Geo-Targeted Marketing

Match user coordinates to ZIP-based demographic datasets (IRS, Census)
Deliver hyper-local campaigns based on proximity

4. 🏥 Emergency & Field Services

Route emergency responders based on distance from ZIP-based facilities
Optimize technician dispatching

5. 🏢 Site Selection & Analytics

Analyze how far a given coordinate is from key ZIP-based markets
Support retail expansion planning

Distance calculations are a foundational capability for many applications like routing, logistics, and geo-targeting.

🔧 Sample Request

GET https://global.metadapi.com/zipc/v2/distancecoord?zipcode=90210&latitude=34.0522&longitude=-118.2437

Sample Response (Simplified)

{
"data": [
{
"zipCode": "90210",
"latitude": 34.0901,
"longitude": -118.4065,
"distanceMiles": 10.23,
"distanceKilometers": 16.46
}
]
}

🔗 How It Fits in Zip Code API v2

The **Zip Code API v2** provides a full suite of location intelligence endpoints, including:

ZIP code lookup
Search & filtering
ZIP-to-ZIP distance
Radius-based queries
IRS income statistics
MSA (Metropolitan Statistical Area) data

The new `/distancecoord` endpoint enhances this ecosystem by connecting ZIP-based data with real-world coordinate systems, making the API even more versatile for modern applications.

🧭 Final Thoughts

With the introduction of the Distance Between ZIP Code and Coordinates endpoint, developers can now seamlessly combine:

Postal geography (ZIP codes)
GPS-based location data (lat/long)

…all within a single API.

Whether you're building logistics platforms, analytics tools, or location-aware applications, this endpoint unlocks a new layer of geospatial capability—without the complexity.

👉 Start using it today as part of Zip Code API v2 and bring precision location intelligence into your applications. Check the endpoint documentation.

Famous ZIP Codes in the United States: What a ZIP Code Is and Why It Exists

Fri, 20 Feb 2026 01:14:25 GMT

What Is a ZIP Code?

A ZIP Code is a postal code used in the United States to identify specific geographic delivery areas. The term ZIP stands for Zone Improvement Plan, a system introduced by the United States Postal Service (USPS) in 1963 to improve the speed and accuracy of mail delivery.

A standard ZIP Code contains five digits:

The first digit represents a group of U.S. states or a large region.
The next two digits identify a sectional center facility (a mail sorting hub).
The last two digits represent a local delivery area.

Later, the ZIP+4 system was introduced to provide even more precise delivery locations, such as specific buildings or city blocks.

Why ZIP Codes Were Created

Before ZIP Codes, mail sorting was largely manual and time-consuming. As the U.S. population and mail volume grew—especially after World War II—the postal system needed a way to automate and standardize delivery routes.

ZIP Codes were created to:

Speed up mail processing
Reduce delivery errors
Enable automated sorting
Improve logistics planning

Today, ZIP Codes are used for far more than mail delivery. Businesses use them for:

Market research and demographic analysis

Targeted marketing and advertising
Territory planning and logistics
Insurance and risk modeling
Real estate analysis

Because ZIP Codes are tied to geography and population patterns, they have become one of the most widely used geographic identifiers in the United States.

The Most Famous ZIP Codes in Each U.S. State

Below is a curated list of well-known ZIP Codes in each state and why they are notable. Fame may come from tourism, economic importance, pop culture, or historical significance.

Alabama — 35203 (Birmingham)

Downtown Birmingham’s historic business district and civil rights landmarks are located in this ZIP Code. Check out some details of zip code 35203

Alaska — 99501 (Anchorage)

Covers downtown Anchorage, the economic and transportation hub of Alaska. Check out the details of zip code 99501.

Arizona — 85001 (Phoenix)

One of the most recognized ZIP Codes in Arizona, covering the state capital’s downtown core. Check out the details of zip code 85001.

Arkansas — 72201 (Little Rock)

Home to downtown Little Rock and major government buildings. Check out the details of zip code 72201.

California — 90210 (Beverly Hills)

Arguably the most famous ZIP Code in the world, associated with wealth, celebrity culture, and the television series Beverly Hills, 90210. Check out the details of zip code 90210.

Colorado — 80202 (Denver)

Known for downtown Denver’s business district and major sports venues. Check out the details of zip code 80202.

Connecticut — 06830 (Greenwich)

A nationally recognized area known for affluence and hedge fund headquarters. Check out the details of zip code 06830.

Delaware — 19801 (Wilmington)

A major financial and corporate center. Check out the details of zip code 19801.

Florida — 33109 (Miami Beach / Fisher Island)

One of the wealthiest ZIP Codes in the United States and known for luxury real estate. Check out the details of zip code 33109.

Georgia — 30303 (Atlanta)

Downtown Atlanta and the city’s historic commercial center. Check out the details of zip code 30303.

Hawaii — 96815 (Waikiki)

Globally recognized tourist destination and beachfront district. Check out the details of zip code 96815.

Idaho — 83702 (Boise)

Downtown Boise and the state capitol area. Check out the details of zip code 83702.

Illinois — 60611 (Chicago)

Home to the Magnificent Mile and luxury retail districts. Check out the details of zip code 60611.

Indiana — 46204 (Indianapolis)

Includes Monument Circle and major sports venues. Check out the details of zip code 46204.

Iowa — 50309 (Des Moines)

Downtown Des Moines and government offices. Check out the details of zip code 50309.

Kansas — 66101 (Kansas City, KS)

Historic downtown and industrial areas near major rail routes. Check out the details of zip code 66101.

Kentucky — 40202 (Louisville)

Downtown Louisville and waterfront redevelopment districts. Check out the details of zip code 40202.

Louisiana — 70116 (New Orleans)

Covers the French Quarter and Bourbon Street, famous worldwide. Check out the details of zip code 70116.

Maine — 04101 (Portland)

Historic waterfront and tourism center. Check out the details of zip code 04101.

Maryland — 20814 (Bethesda)

Known for healthcare institutions and proximity to Washington, D.C. Check out the details of zip code 20814.

Massachusetts — 02108 (Boston)

Beacon Hill, one of the oldest and most historic neighborhoods in the U.S. Check out the details of zip code 02108.

Michigan — 48226 (Detroit)

Downtown Detroit and historic financial district. Check out the details of zip code 48226.

Minnesota — 55401 (Minneapolis)

Central business district and sports venues. Check out the details of zip code 55401.

Mississippi — 39201 (Jackson)

Downtown Jackson and government buildings. Check out the details of zip code 39201.

Missouri — 63102 (St. Louis)

Gateway Arch and historic riverfront. Check out the details of zip code 63102.

Montana — 59715 (Bozeman)

Popular for tourism and outdoor recreation near Yellowstone. Check out the details of zip code 59715.

Nebraska — 68102 (Omaha)

Old Market district and downtown Omaha. Check out the details of zip code 68102.

Nevada — 89109 (Las Vegas)

The Las Vegas Strip, one of the most visited destinations in the world. Check out the details of zip code 89109.

New Hampshire — 03801 (Portsmouth)

Historic coastal city known for tourism. Check out the details of zip code 03801.

New Jersey — 07097 (Jersey City)

Major financial district with Manhattan skyline views. Check out the details of zip code 07097.

New Mexico — 87501 (Santa Fe)

Historic downtown known for art and architecture. Check out the details of zip code 87501.

New York — 10001 (New York City)

The first ZIP Code ever assigned and located in Manhattan. Check out the details of zip code 10001.

North Carolina — 28202 (Charlotte)

Major banking and financial hub. Check out the details of zip code 28202.

North Dakota — 58102 (Fargo)

Historic downtown Fargo and university areas. Check out the details of zip code 58102.

Ohio — 44114 (Cleveland)

Downtown Cleveland near major cultural attractions. Check out the details of zip code 44114.

Oklahoma — 73102 (Oklahoma City)

Bricktown and downtown entertainment districts. Check out the details of zip code 73102.

Oregon — 97209 (Portland)

Pearl District, known for redevelopment and culture. Check out the details of zip code 97209.

Pennsylvania — 19103 (Philadelphia)

Rittenhouse Square and upscale urban living. Check out the details of zip code 19103.

Rhode Island — 02903 (Providence)

Downtown Providence and historic districts. Check out the details of zip code 02903.

South Carolina — 29401 (Charleston)

Historic architecture and tourism. Check out the details of zip code 29401.

South Dakota — 57701 (Rapid City)

Gateway to Mount Rushmore. Check out the details of zip code 57701.

Tennessee — 37203 (Nashville)

Music Row and entertainment districts. Check out the details of zip code 37203.

Texas — 77002 (Houston)

Downtown Houston and the energy industry. Check out the details of zip code 77002.

Utah — 84101 (Salt Lake City)

Downtown and Temple Square area. Check out the details of zip code 84101.

Vermont — 05401 (Burlington)

Lakefront and university area. Check out the details of zip code 05401.

Virginia — 22314 (Alexandria)

Old Town Alexandria and historic waterfront. Check out the details of zip code 22314.

Washington — 98101 (Seattle)

Retail core and tourism center. Check out the details of zip code 98101.

West Virginia — 25301 (Charleston)

State government and business district. Check out the details of zip code 25301.

Wisconsin — 53202 (Milwaukee)

Lakefront, entertainment, and business districts. Check out the details of zip code 53202.

Wyoming — 82001 (Cheyenne)

State capital and historic railroad hub. Check out the details of zip code 82001.

How Businesses Use ZIP Codes Today

ZIP Codes have evolved into a critical tool for:

Location intelligence
Customer segmentation
Territory planning
Delivery optimization
Demographic analysis

For marketers and data professionals, ZIP Codes provide a powerful way to understand geographic patterns in income, population, and consumer behavior.

For example, let's compare AGI (Adjusted Gross Income) returns between these zip codes and find out how each is performing. Below is a code excerpt, you can download the full Python code from our Github Repository. The full code does the following:

Uses a list of the most famous zip codes in this blog article.
Leverages the end point /zipc/v1/zipcodes/{zipcode}/soi?year=2022 to get return statistics for each zip code.
Aggregates the data by zip code and sorts the result in descending order.
Plots a bar graph with each zip code sorted from top income to lowest income in the list.

def get_agi_total_single_year(zipcode, year):
    url = f"{BASE_URL}/{zipcode}/soi?year={year}"
    response = requests.get(url, headers=headers)

    if response.status_code != 200:
        print(f"Error for {zipcode}: {response.status_code}")
        return None

    data = response.json().get("data", [])
    df = pd.DataFrame(data)

    if df.empty:
        return None

    # Ensure numeric
    df["agiGroupId"] = pd.to_numeric(df["agiGroupId"], errors="coerce")
    df["adjustedGrossIncome"] = pd.to_numeric(df["adjustedGrossIncome"], errors="coerce")

    # Filter AGI groups 1–6
    df = df[df["agiGroupId"].between(1, 6)]

    total_agi = df["adjustedGrossIncome"].sum()

    return total_agi

When running this python code you should get the following graph:

Get the full Python code

Conclusion

ZIP Codes began as a way to make mail delivery faster and more reliable, but they have become an essential part of modern business, logistics, and data analysis. Some ZIP Codes have achieved nationwide recognition due to wealth, tourism, history, or pop culture—making them part of the broader cultural landscape of the United States. Leverage our zip code API to uncover key data to help you manage your business decisions.

Mapping IRS 1040 Tax Data with the Zip Code API: A Complete Guide

Tue, 21 Oct 2025 22:15:16 GMT

Introduction

When analyzing local markets, income patterns, or demographic segments, raw IRS data can be a goldmine — but it’s often difficult to interpret and integrate. The IRS 1040 Individual Tax Return dataset contains rich information about how Americans earn and report income across every ZIP code, yet working directly with these files requires significant data wrangling.

That’s where the Zip Code API from Metadapi comes in. Our API simplifies access to this information by mapping key IRS 1040 fields to our SOI (Statistics of Income) endpoint. Instead of downloading massive spreadsheets, decoding variable names and cleaning data, developers and analysts can pull precise tax-related metrics for any U.S. ZIP code in seconds.

This guide walks you through how the IRS 1040 data is mapped within the Zip Code API, what each field represents, and how to use it effectively for your projects.

Understanding the Source: IRS 1040 Data

The IRS releases anonymized, aggregated data each year based on the Form 1040 — the U.S. Individual Income Tax Return. This dataset summarizes filing activity and income components by ZIP code, giving an unparalleled look into local economic characteristics.

Some examples of what the IRS 1040 data reveals:

Number of individual tax returns filed per ZIP code
Total and average Adjusted Gross Income (AGI)
Number of dependents claimed
Distribution of returns by income bracket
Types of income (wages, dividends, self-employment, etc.)
Total taxable income and total tax paid

For marketers, researchers, and developers, these metrics can reveal income distribution patterns, household size trends, and economic vitality at the community level.

The Zip Code API Mapping

The Zip Code API organizes these IRS metrics into structured, developer-friendly fields that align directly with 1040 variables. Here’s a simplified look at how some of the mappings work:

In the below example, we are going to focus on 4 tax return measures. Taxable Interest, Ordinary Dividends, Total Income and Adjusted Gross Income. (Our dataset includes hundreds of different return metrics, but for this example, we'll focus on only 4 of them).

The data provided by the IRS is "grouped" into 6 categories based on the size of the adjusted gross income reported:

Size of adjusted gross income Id:

1 = $1 under $25,000
2 = $25,000 under $50,000
3 = $50,000 under $75,000
4 = $75,000 under $100,000
5 = $100,000 under $200,000
6 = $200,000 or more

Our API documentation includes the mapping reference to both the IRS variable name as well as the Tax form box it relates to. For example, to get AGI (Adjusted Gross Income) we look at field adjustedGrossIncome in the documentation and we find the following information:

From there we know that the AGI is related to variable A00100 and you can find this amount on the tax form 1040 Box 11

Looking at the other field documentation, we can find:

We found the right fields we are interested in. Now it's time to call the API, using the following endpoint (only for year 2022):

https://global.metadapi.com/zipc/v1/zipcodes/90210/soi?year=2022

The JSON response includes all the attributes provided by the IRS, for simplicity we'll format the result in an easy to read table (amounts are in '000)

		AGI Group ID
Zip Code	Attribute	1	2	3	4	5	6	Total
90210	returns	1,710	950	730	570	1,330	3,740	9,030
	adjustedGrossIncome	$ 17,669	$ 34,935	$ 45,672	$ 49,634	$ 191,474	$ 5,664,409	$ 6,003,793
	returnsWithTotalIncome	1,710	950	730	570	1,330	3,740	9,030
	totalIncomeAmount	$ 18,637	$ 36,206	$ 46,927	$ 50,978	$ 196,128	$ 5,721,670	$ 6,070,546
	returnsWithTaxableinterest	660	430	360	310	920	3,340	6,020
	taxableinterestAmount	$ 1,018	$ 1,498	$ 1,920	$ 1,209	$ 6,758	$ 226,152	$ 238,555
	returnsWithOrdinaryDividends	550	330	300	270	710	2,780	4,940
	ordinaryDividendsAmount	$ 2,718	$ 2,878	$ 3,739	$ 4,139	$ 12,605	$ 517,408	$ 543,487

From this result we can now produce all types of analytics or applications that leverage this data.

Instead of handling raw column codes like A00200 or N02650, you get intuitive JSON fields ready to integrate into your dashboards, reports, or applications.

Why This Mapping Matters

1. Time Savings for Developers

The IRS raw data is extremely detailed but not immediately usable. It requires decoding hundreds of field codes and applying proper weighting. The Zip Code API abstracts all of this complexity, letting you access IRS-sourced data in seconds.

2. Consistent Field Definitions

Every field in the API corresponds to an exact IRS definition. That means your calculations and visualizations remain accurate and consistent with official government data.

3. Geographic Precision

Since the dataset is ZIP code–based, you can zoom into highly localized areas — ideal for comparing neighborhoods, sales territories, or marketing zones.

4. Use Cases Across Industries

Marketing & Advertising: Target areas by income level or number of dependents.
Real Estate: Identify ZIP codes with higher disposable income or family density.
Finance & Lending: Evaluate borrower risk by local average AGI and tax liability.
Public Policy & Research: Measure income inequality or economic growth by region.

Example Queries and Use Cases

Example 1: Compare Income Levels Between Two ZIP Codes

https://global.metadapi.com/zipc/v1/zipcodes/94103/soi
https://global.metadapi.com/zipc/v1/zipcodes/94016/soi

Compare the adjustedGrossIncome and returns fields to measure income concentration between urban and suburban areas.

Example 2: Identify ZIP Codes with High Business Income

Filter by:

"businessOrProfessionalNetIncomeAmount" > 100000000

This helps pinpoint areas with high levels of self-employment or small business activity.

Getting Started with the API

To explore the mappings and documentation:

Visit https://www.metadapi.com/API-Products/Zip-Code-API
Sign up for a free developer account.
Review the IRS Mapping Documentation section to see every 1040 variable available.
Use your API key to query any ZIP code for immediate JSON data.

Best Practices for Using IRS-Based Data

Normalize for Population Size: Always compare ratios (e.g., AGI per return) rather than raw totals when analyzing across ZIP codes.
Combine with Demographics: Layer in population, or census data for richer insights.
Respect Data Granularity: IRS data is aggregated to protect privacy, so treat it as indicative rather than exact for individual-level analysis.

Conclusion

The Zip Code API transforms complex IRS 1040 return data into an accessible, structured format that anyone can use — whether you’re a developer integrating financial indicators, a marketer refining audience profiles, or a researcher studying local economies.

By providing clear field mappings between the IRS 1040 dataset and the API’s endpoints, you gain reliable access to official income and tax insights for every ZIP code in the United States — without the need for manual data processing.

Explore the documentation today and start building smarter, data-driven applications powered by accurate, IRS-sourced insights.

Unlocking Local Insights: Income by Zip Code

Thu, 12 Jun 2025 15:39:11 GMT

Introduction

When you’re crafting a marketing strategy, opening a new retail location, or pitching real-estate investments, “average household income” is more than a vanity metric—it’s a compass. Granular, up-to-date income data at the ZIP-code level lets you:

Target with precision – Tailor offers or ad spend to pockets of higher disposable income instead of blanketing an entire DMA.
Prioritize expansion – Rank candidate neighborhoods for your next storefront or service area by purchasing power.
Refine look-alike models – Feed income tiers into audience-building tools to spot similar high-value zones nationwide.
Benchmark performance – Compare current store revenue against local earning capacity to find outliers—good or bad.
Strengthen investor decks – Back up “prime location” claims with IRS-sourced tax-return evidence, not anecdotal observations.

A Quick Demo: Finding High-Income Neighbors with Python

Below is the workflow of a simple Python script you could share with analysts or data-savvy clients. It takes three inputs and returns a shortlist of nearby ZIP codes whose **average income** beats a user-defined threshold.

Step	What Happens	Why it matters
1. Prompt for inputs	zip_code (any zip code), radius_miles (input the surrounding radius zip code list), income_threshold (in 000's).	Keeps the tool flexible for any geography or campaign.
2. Build a Radius Query	Using the Zip Code radius endpoint, get all of the zip codes that fall within the prompted radius.	Marketers often care about “drivable distance” rather than arbitrary county lines.
3. Fetch IRS Statistics of Income by Zip Code and calculate average income	Grab `Total Gross Income` and `Number of Returns` for each candidate ZIP. avg_income = total_gross_income / returns	While the sample code uses only 2 fields (e.g. Adjusted Gross Income and Number of Returns), it is designed as a starting point to show how demographic data can be used in marketing use cases. The same API includes dozens of other statistical fields which marketers can easily incorporate to refine their targeting strategies.
4. Print & Sort Results	Flag rows where `avg_income > income_threshold`; optionally sort descending.	Instantly surfaces the high-value zones worth further attention.

Let's review the code needed for each step

1. Prompt for Inputs

When you run the python script it will ask for 3 parameters. 1. The zip code. Second a radius in Miles. and Third the income threshold in thousands. (i.e. to represent 100,000 you type 100.) The python code used to ask for input is:

zip_code = input("Enter your ZIP code: ")
radius = input("Enter a radius in miles: ")
input_threshold = input("Enter Thresholds in 000's: ")

2. Build a radius query

To accomplish this, we have a function that takes as parameters the zip code value and the radius. Then we leverage the Zip Code Radius endpoint to get a list of zip codes that fall within the provided radius. The function will return an array with all the zip codes that are within the provided radius. The Python code of the function:

def get_zips_in_radius(zipcode, radius):
    # Define the API endpoint
    url = f"https://global.metadapi.com/zipc/v1/radius?radius={radius}&uom=mi&zipcode={zipcode}"
    zips = []
    try:
        # Make the API request
        response = requests.get(url,headers=vheaders)
        response.raise_for_status()  # Raise an error for unsuccessful responses
        # Parse the JSON response
        data = response.json()
        for zipresp in data["data"]:
            zips.append(zipresp["zipCode"])
    except requests.exceptions.RequestException as e:
        print('error returning the json')
        print(f"An error occurred: {e}")
        return None
    return zips

3. Fetch IRS Statistics of income by zip code and calculate average income

To accomplish this, we must take each of the zip codes provided by the previous function and get the income statistics for the year of 2021 (this parameter can be changed, and we can also query for multiple years). We leverage the Zip Code IRS Statistics of Income endpoint and get the Number of returns and the adjusted gross income (AGI) to calculate the average income per zip code, this allows us to smooth out population size differences—useful when comparing a dense city core with a suburban pocket.

def get_total_returns(zipcode, threshold):
    # Define the API endpoint
    url = f"https://global.metadapi.com/zipc/v1/zipcodes/{zipcode}/soi?year=2021"
    try:
        # Make the API request
        response = requests.get(url,headers=vheaders)
        response.raise_for_status()  # Raise an error for unsuccessful responses
        
        # Parse the JSON response
        data = response.json()
        total_returns = sum(item["returns"] for item in data["data"])
        total_agi = sum(item["adjustedGrossIncome"] for item in data["data"])
        if total_returns > 0 :
                avg_agi = total_agi/total_returns
                meets_threshold = "yes" if avg_agi > threshold else "no"
        else:
            avg_agi = 0
            meets_threshold = "no"
        agi_object = {"zipcode":zipcode, "totalAgi":total_agi, "totalReturns": total_returns, "avgAgi":avg_agi, "threshold" : threshold, "meets_threshold" : meets_threshold}
        time.sleep(0.5)
        return agi_object
    
    except requests.exceptions.RequestException as e:
        print('error returning the json')
        print(f"An error occurred: {e}")
        return None

4. Print and Sort results

Finally we create a data frame with the results, and we sort and print this to screen. This will allow us to review the data and understand the zip's that meet the threshold criteria.

	df = pd.DataFrame(analysis_dataset)
    sorted_df = df.sort_values(by="avgAgi", ascending=False)
    print(sorted_df)

You can download the full code of this script in our zip code github repository (you can review this repository for more code samples that leverage the zip code API).

When we run the script, using the following sample:

Sample Output

Enter base ZIP: 19103
Enter radius (miles): 15
Income threshold ($): 95

Extending the Script

Visualization – Drop results into Plotly or Folium to create a heat-map pinwheel around your base ZIP.
Additional filters* – Layer in filing status, or population density to refine prospect lists.
Batch mode – Loop through multiple anchor ZIPs to automate territory planning for regional sales teams.
Integration – Expose it as a microservice so non-technical teammates can hit an endpoint from Excel or Zapier.

Key Takeaways

Having Income by ZIP Code at your fingertips isn’t just academic—it’s actionable. Whether you’re optimizing ad bids, scouting expansion zones, or validating a property’s upside, localized income stats transform hunches into data-driven moves.

Ready to put it to work? Grab the demo script, plug in your API key for the Zip Code API , and start illuminating your income targets hiding in plain sight!

Try Today!

How Demographic data by Zip Code Enhances Ad Targeting

Sun, 20 Apr 2025 23:20:00 GMT

In today's competitive marketing landscape, businesses must deliver highly targeted ads to maximize engagement and ROI. By leveraging demographic data by zip code, advertisers can refine their audience segmentation, personalize messaging, and optimize ad spend.

Here’s how it can improve advertising effectiveness:

1. Hyper-Targeted Audience Segmentation

Instead of broad, generic ads, businesses can tailor their campaigns based on income, age, household size, and lifestyle preferences in specific zip codes.
- Example: A luxury car brand can focus ads on high-income zip codes, while a discount retailer targets lower-income areas.

2. Location-Based Personalization

Different neighborhoods have different consumer behaviors. Knowing these trends helps create personalized messaging that resonates with local audiences.
- Example: A gym chain can advertise weight-loss programs in zip codes where health-conscious individuals are concentrated.

3. Optimized Ad Spend & Reduced Waste

Businesses can avoid ad spend waste by excluding areas that don’t match their ideal customer profile.
- Example: A high-end steakhouse wouldn’t advertise in areas with a high percentage of vegetarians.

4. Improved Direct Mail & Local Promotions

Direct mail campaigns can be optimized by sending flyers or postcards only to relevant households.
- Example: A real estate agency can target zip codes with high homeownership rates for refinancing offers.

5. Better Social Media & Digital Ads

Platforms like Facebook, Google Ads, and TikTok allow businesses to target audiences based on location, making zip code demographic data crucial for geo-targeting.
- Example: A luxury fashion brand can set Facebook ads to appear in high-income zip codes with high online shopping activity.

6. Enhanced Competitor Analysis

Businesses can identify where their competitors are thriving and adjust their strategy accordingly.
- Example: A new restaurant can analyze zip codes with a strong competitor presence and decide whether to compete or find untapped markets.

7. Seasonal & Event-Based Marketing

Certain areas have seasonal trends that impact consumer demand. Businesses can adjust their ads based on local events, holidays, or climate-specific needs.
- Example: A ski resort can increase advertising in zip codes that show interest in winter sports.

By integrating demographic data by zip code into ad targeting strategies, businesses can maximize engagement, improve ROI, and create highly relevant, localized marketing campaigns.

Top 5 Benefits of Accessing Zip Code Data through an API

Tue, 05 Nov 2024 00:03:00 GMT

In an increasingly data-driven world, access to detailed and accurate zip code data is invaluable. Businesses, researchers, marketers, and developers leverage this data to gain insights, streamline services, and make strategic decisions. An API that provides zip code-based data and statistics unlocks incredible potential. Here’s why accessing zip code data through an API can be a game-changer and the top five benefits it offers.

Accessing data typically reserved for analytics and reporting through an API unlocks real-time, flexible integration opportunities, empowering businesses to build more responsive, data-driven applications, websites, and mobile apps. This approach enables businesses to make data-driven decisions faster, personalize customer experiences, and streamline workflows with up-to-date insights. For example, an API providing IRS-based zip code statistics could transform financial planning, marketing workflows, and risk assessments in real time. By offering zip code data that that has been curated, integrated and made available (in easy to consume data models), we can streamline development that otherwise would take months to accomplish.

Benefits

1. Real-Time Data Access and Automation

One of the biggest advantages of accessing zip code data through an API is the ability to retrieve updated information in real-time. APIs enable seamless integration with your systems, which means data is refreshed without manual effort. This can be invaluable for applications that need to stay current, such as tracking demographic shifts, economic trends, or changes in income distributions within specific areas. Automated data updates also mean less manual work and reduced chances of errors, allowing your team to focus on higher-level analytics and decision-making.

2. Precision in Targeting and Marketing

APIs allow businesses to obtain hyper-local data that can refine marketing efforts, which is particularly useful in geotargeting strategies. By accessing demographic and economic data down to the zip code level, companies can better understand regional preferences and economic profiles, creating highly tailored marketing campaigns. For example, knowing average income levels, family sizes, or household spending behaviors within specific zip codes can help craft messages that resonate with specific audiences, improving engagement and conversions.

3. Enhanced Data Depth and Customization

A zip code data API can offer extensive details beyond basic location data, such as insights into tax returns, income distribution, employment rates, and even migration trends. By customizing API queries, users can filter and aggregate data based on their specific needs, extracting only the most relevant information. This is particularly useful for industries like finance, real estate, and urban planning, where nuanced understanding of local economic trends is crucial for making informed decisions.

4. Scalability for Large-Scale Data Analysis

For companies managing extensive datasets or conducting large-scale geographic analyses, APIs streamline the process, making it efficient and scalable. Rather than downloading and processing massive datasets manually, APIs can be used to access only the data that’s needed when it’s needed, saving both time and resources. This makes it possible to analyze zip code data across thousands of locations without straining infrastructure, which is especially useful for applications such as market analysis, competitor benchmarking, and location-based service optimization.

5. Improved User Experience with Seamless Integration

For applications that involve user interaction — such as real estate apps, travel services, or e-commerce platforms — an API with zip code data can provide an enhanced user experience. Integrating zip code data directly into user-facing applications allows you to offer personalized services, like showing nearby service providers, estimating delivery times based on geographic data, or even recommending products that are popular within certain zip codes. This localization can improve customer satisfaction by making interactions feel more relevant and convenient.

Sample Use cases

Real Estate and Financial Services

Use Case: A real estate app integrates the API to display neighborhood income statistics, average tax return values, and investment patterns, helping users make more informed buying or selling decisions.
Benefit: Homebuyers and investors can gauge the financial health and growth potential of different zip codes, enhancing transparency in the market.

Retail and E-commerce

Use Case: An e-commerce website uses the API to tailor product recommendations and promotions based on regional income and spending trends.
Benefit: Personalized shopping experiences boost conversions, customer loyalty, and satisfaction, driving sales across various demographics.
Marketing and Advertising:

Use Case: A marketing platform integrates the API to enhance audience segmentation, allowing campaigns to target zip codes with specific income levels, age groups, or spending behaviors.
Benefit: Marketers can run more precise campaigns, improving ROI by reaching the right audience with relevant content.
Insurance and Risk Assessment:

Use Case: Insurance companies use the API for risk assessment in different zip codes based on income stability and economic trends.
Benefit: With data-driven risk models, insurance companies can adjust premiums accurately and reduce losses, while customers receive fairer pricing.
Public Policy and Nonprofit Organizations:

Use Case: Nonprofits use the API to allocate resources to zip codes showing signs of economic decline or low income levels, prioritizing areas with higher need.
Benefit: Organizations can maximize the impact of resources and support services by targeting communities most likely to benefit, enhancing social outcomes.

Healthcare and Wellness

Use Case: Healthcare providers integrate the API to identify regional health patterns linked to economic data (e.g., income vs. wellness spending) for community-targeted health initiatives.
Benefit: By understanding economic factors influencing health, providers can better address community needs, enhancing public health outcomes.
Travel and Hospitality:

Use Case: Travel companies use the API to understand which zip codes have higher disposable incomes, allowing them to target potential travelers with customized vacation packages.
Benefit: This data allows travel brands to promote premium offerings to audiences with higher travel budgets, boosting booking rates and customer satisfaction.

Conclusion

Accessing zip code data through an API opens up a world of opportunities for precise targeting, in-depth analytics, and operational efficiency. From real-time access to scalable, customized data solutions, APIs make it easier to harness the power of geographic data at any scale. By integrating a zip code data API into your business processes, you can unlock powerful insights and improve service delivery for a range of applications. So, whether you’re looking to optimize marketing efforts, enhance user experiences, or drive strategic decisions, a zip code data API could be a valuable asset in achieving your goals.

The Power of Zip Code Statistics: Leveraging IRS Data for Targeted Market Analysis

Thu, 05 Sep 2024 23:30:10 GMT

The Power of Zip Code Data

A zip code might seem like a simple numerical identifier, but it holds an immense amount of information. Every zip code represents a unique community, each with its own demographics, income levels, spending patterns, and economic behaviors. By tapping into IRS data, which provides detailed statistics on income distributions across different zip codes, businesses can gain a deeper understanding of who their potential customers are, what they earn, and how they might behave economically.

Why IRS Data?

The IRS collects income data from tax returns, making it one of the most comprehensive and reliable sources for analyzing regional economic conditions. When integrated into a market analysis, IRS income data provides insights that can help businesses:

Understand the average income levels within specific zip codes.
Identify high-income and low-income areas, enabling businesses to target their products and services more effectively.
Recognize economic trends that might influence spending habits or demand for particular products.

With this level of insight, companies can make data-driven decisions that take into account the unique economic conditions of the regions they serve, leading to more successful outcomes.

The Role of Market Analysis in Targeted Marketing

Effective marketing starts with understanding your audience. Market analysis that leverages zip code statistics helps businesses break down complex consumer data into actionable insights. Instead of guessing what potential customers need or want, companies can use data-driven approaches to identify areas of opportunity and tailor their strategies to specific segments.

For example, a luxury brand selling high-end products can focus its efforts on regions with higher income levels, as determined by IRS data. Meanwhile, a budget-friendly retailer might target regions with lower average incomes, adjusting their messaging and product offerings to align with local economic realities.

Benefits of Data-Driven Market Analysis

Improved Customer Targeting: By analyzing zip code statistics based on IRS data, businesses can ensure their marketing efforts reach the right people. This reduces wasted resources on untargeted campaigns.
Enhanced ROI: Tailoring your strategy based on accurate data leads to more effective campaigns and, ultimately, a better return on investment (ROI).
Smarter Product Distribution: Knowing where potential customers with specific income levels live helps businesses decide where to stock certain products and services.
Localized Marketing Strategies: Every region is different. A one-size-fits-all marketing strategy is likely to fall flat. By using detailed income data, businesses can create marketing campaigns that resonate with local audiences.

How to Access IRS Zip Code Statistics

Accessing this powerful data doesn’t have to be complicated. Through the Zip Code API endpoint that returns IRS income statistics by zip code, businesses can easily integrate this data into their existing systems. This API provides access to critical information, allowing for quick and effective market analysis.

GET https://global.metadapi.com/zipc/v1/zipcodes/{zipcode}/soi

Using the endpoint IRS income statistics API, businesses can:

Request data for specific zip codes or a range of zip codes.
Analyze average income levels, identifying where higher or lower incomes are concentrated.
Visualize income distribution to understand how wealth is spread across different regions.

This API simplifies the process of gathering detailed market data, enabling businesses to harness the full power of zip code statistics and make better, faster, and more informed decisions.

Sample request to get the statistics of income for zip code 90210 for the year of 2021:

GET https://global.metadapi.com/zipc/v1/zipcodes/90210/soi?year=2021

{
    "links": {
        "self": "https://global.metadapi.com/zipc/v1/zipcodes/90210/soi?year=2021"
    },
    "meta": {
        "count": 6
    },
    "data": [
        {
            "zipCode": "90210",
            "year": 2021,
            "agiGroupId": "1",
            "agiGroup": "$1 under $25,000",
            "returns": 1720,
            "singleReturns": 1470,
            "jointReturns": 130,
            "headOfHouseholdReturns": 60,
            "electronicallyFilledReturns": 1550,
            "computerPreparedPaperReturns": 70,
            "returnsWithPaidPreparedSignature": 1340,
            "returnsWithDirectDeposit": 560,
            "returnsWithVirtualCurrency": 80,
            "numberOfIndividuals": 1630,
            "volunteerPreparedReturns": 0,
            "vitaPreparedReturns": 0,
            "tcePreparedReturns": 0,
            "eicVolunteerPreparedReturns": 0,
            "refundAnticipationCheckReturns": 50,
            "elderlyReturns": 340,
            "adjustedGrossIncome": 19887,
            "returnsWithTotalIncome": 1720,
            "totalIncomeAmount": 20770,
            "returnsWithSalariesWages": 770,
            "salariesWagesAmount": 10501,
            "returnsWithTaxableinterest": 510,
            "taxableinterestAmount": 986,
            "returnsWithOrdinaryDividends": 530,
            "ordinaryDividendsAmount": 1725,
            "returnsWithQualifiedDividends": 490,
            "qualifiedDividendsAmount": 1104,
            "returnsStateLocalIncomeTaxRefunds": 0,
            "stateLocalIncomeTaxRefundAmount": 0,
            "returnsWithBusinessOrProfessionalNetIncome": 510,
            "businessOrProfessionalNetIncomeAmount": 2475,
            "returnsWithNetCapitalGain": 530,
            "netCapitalGainAmount": 2953,
            "returnsWithTaxableIraDistributions": 60,
            "taxableIradistributionAmount": 354,
            "returnsWithTaxablePensionsAnnuities": 60,
            "taxablePensionsAndAnnuitiesAmount": 540,
            "returnsFarms": 0,
            "returnsWithUnemploymentCompensation": 310,
            "unemploymentCompensationAmount": 4720,
            "returnsWithTaxableSocialSecurityBenefits": 70,
            "taxableSocialSecurityBenefitsAmount": 205,
            "returnsWithPartnershipNetIncome": 180,
            "partnershipNetIncomeAmount": -715,
            "returnsWithTotalStatutoryAdjustments": 460,
            "totalStatutoryAdjustmentsAmount": 883,
            "returnsWithEducatorExpenses": 0,
            "educatorExpensesAmount": 0,
            "returnsWithSelfEmployedRetirementPlans": 0,
            "selfEmployedRetirementPlansAmount": 0,
            "returnsWithSelfEmployedHealthInsuranceDeduction": 50,
            "selfEmployedHealthInsuranceDeductionAmount": 291,
            "returnsWIthIraPayments": 0,
            "iraPaymentAmount": 0,
            "returnsWithStudenLoaninterestDeduction": 30,
            "studentLoaninterestDeductionAmount": 38,
            "returnsWithCharitableContributionsWithStandardDeductions": 300,
            "charitableContributionsWithStandardDeductionsAmount": 79,
            "returnsWithTotalStandardDeduction": 1560,
            "standardDeductionAmount": 18751,
            "returnsWithBasicStandardDeduction": 1560,
            "basicStandardDeductionAmount": 18388,
            "returnsWithAdditionalStandardDeduction": 200,
            "additionalStandardDeductionAmount": 363,
            "returnsWithItemizedDeductions": 150,
            "itemizedDeductionsAmount": 4743,
            "agiForItemizedReturnsAmount": 1871,
            "returnsWithTotalMedicalDentalDeduction": 90,
            "totalMedicalDentalDeductionAmount": 2033,
            "returnsWithStateAndLocalIncomeTaxes": 70,
            "stateAndLocalIncomeTaxesAmount": 363,
            "returnsWIthStateAndLocalGeneralSalesTax": 80,
            "stateAndLocalGeneralSalesTaxAmount": 52,
            "returnsWithRealEstateTaxes": 90,
            "realEstateTaxesAmount": 1786,
            "returnsWithPersonalPropertyTaxes": 30,
            "personalPropertyTaxesAmount": 16,
            "returnsWithLimitedStateLocalTaxes": 150,
            "limitedStateLocalTaxesAmount": 896,
            "returnsWithTotalTaxesPaid": 150,
            "totalTaxesPaidAmount": 878,
            "returnsWithHomeMortageInterestPaid": 70,
            "homeMortgageInterestPaidAmount": 1341,
            "returnsWithHomeMortgageFromPersonalSeller": 0,
            "homeMortgageFromPersonalSellerAmount": 0,
            "returnsWithDeductiblePoints": 0,
            "deductiblePointsAmount": 0,
            "returnsWithQualifiedMortgageInsurancePremiums": 0,
            "qualifiedMortgageInsurancePremiumsAmount": 0,
            "returnsWithInvestmentInterestPaid": 30,
            "investmentInterestPaidAmount": 299,
            "returnsWithTotalCharitableContributions": 80,
            "totalCharitableContributionsAmount": 286,
            "returnsWithOtherNonLimitedMiscDeductions": 0,
            "otherNonLimitedMiscDeductionsAmount": 0,
            "returnsWithQualifiedBusinessIncomeDeduction": 210,
            "qualifiedBusinessIncomeDeductionAmount": 168,
            "returnsWithTaxableIncome": 770,
            "taxableIncomeAmount": 4496,
            "returnsWithIncomeTaxBeforeCredits": 700,
            "incomeTaxBeforeCreditsAmount": 449,
            "returnsWithAlternativeMinimumTax": 0,
            "alternativeMinimumTaxAmount": 0,
            "returnsWithExcessAdvancePremiumTaxCreditRepayment": 30,
            "excessAdvancePremiumTaxCreditRepaymentAmount": 6,
            "returnsWithTotalTaxCredits": 190,
            "totalTaxCreditsAmount": 65,
            "returnsWithForeignTaxCredit": 70,
            "foreignTaxCreditAmount": 8,
            "returnsWithChildAndDependentCareCredit": 0,
            "childAndDependentCareCreditAmount": 0,
            "returnsWithNonRefundableEducationCredit": 80,
            "nonRefundableEducationCreditAmount": 46,
            "returnsWithRetirementSavingsContributionCredit": 30,
            "retirementSavingsContributionCreditAmount": 6,
            "returnsWithChildAndOtherDependentCredit": 0,
            "childAndOtherDependentCreditAmount": 0,
            "returnsWithResidentialEnergyTaxCredit": 0,
            "residentialEnergyTaxCreditAmount": 0,
            "returnsWithSelfEmploymentTax": 420,
            "selfEmploymentTaxAmount": 614,
            "returnsWithTotalPremiumTaxCredit": 160,
            "totalPremiumTaxCreditAmount": 835,
            "returnsWithAdvancePremiumTaxCredit": 160,
            "advancePremiumTaxCreditAmount": 797,
            "returnsWithTotalTaxPayments": 1170,
            "totalTaxPaymentsAmount": 3829,
            "returnsWithEarnedIncomeCredit": 490,
            "earnedIncomeCreditAmount": 535,
            "returnsWithExcessEarnedIncomeCredit": 320,
            "excessEarnedIncomeCreditAmount": 320,
            "returnsWithAdditionalChildTaxCredit": 80,
            "additionalChildTaxCreditAmount": 207,
            "returnsWithRefundableEducationCredit": 90,
            "refundableEducationCreditAmount": 84,
            "returnsWithNetPremiumTaxCredit": 90,
            "netPremiumTaxCreditAmount": 75,
            "returnsWithQualifiedSickAndFamilyLeaveCredit": 20,
            "qualifiedSickAndFamilyLeaveCreditAmount": 53,
            "returnsWithRefundableChildAndDependentCredit": 0,
            "refundableChildAndDependentCareCreditAmount": 0,
            "returnsWithQualifiedSickAndFamilyLeaveCredit11530": 20,
            "qualifiedSickAndFamilyLeaveCreditAmount11530": 88,
            "returnsWithRecoveryRebateCredit": 160,
            "recoveryRebateCreditAmount": 254,
            "returnsWithEconomicImpactPaymentFirstRound": 1070,
            "economicImpactPaymentFirstRoundAmount": 1871,
            "returnsWitheconomicImpactPaymentSecondRound": 600,
            "economicImpactPaymentSecondRoundAmount": 383,
            "returnsWithIncomeTaxAfterCredits": 890,
            "incomeTaxAfterCreditAmount": 1094,
            "returnsWithTaxLiability": 0,
            "taxLiabilityAmount": 0,
            "returnsWithAdditionalMedicareTax": 0,
            "additionalMedicareTaxAmount": 0,
            "returnsWithNetInvestmentIncomeTax": 420,
            "netInvestmentIncomeTaxAmount": 451,
            "returnsWithTaxDueAtTimeOfFiling": 960,
            "taxDueAtTimeOfFilingAmount": 3183,
            "returnsWithOverpaymentsRefunded": 850,
            "overpaymentRefundedAmount": 1830,
            "returnsWithCreditToNextYearTax": 120,
            "creditToNextYearTaxAmount": 596
        },
        {
            "zipCode": "90210",
            "year": 2021,
            "agiGroupId": "2",
            "agiGroup": "$25,000 under $50,000",
            "returns": 1010,
            "singleReturns": 800,
            "jointReturns": 130,
            "headOfHouseholdReturns": 50,
            "electronicallyFilledReturns": 920,
            "computerPreparedPaperReturns": 50,
            "returnsWithPaidPreparedSignature": 770,
            "returnsWithDirectDeposit": 370,
            "returnsWithVirtualCurrency": 60,
            "numberOfIndividuals": 1280,
            "volunteerPreparedReturns": 0,
            "vitaPreparedReturns": 0,
            "tcePreparedReturns": 0,
            "eicVolunteerPreparedReturns": 0,
            "refundAnticipationCheckReturns": 40,
            "elderlyReturns": 240,
            "adjustedGrossIncome": 36621,
            "returnsWithTotalIncome": 1010,
            "totalIncomeAmount": 37754,
            "returnsWithSalariesWages": 610,
            "salariesWagesAmount": 18634,
            "returnsWithTaxableinterest": 420,
            "taxableinterestAmount": 1080,
            "returnsWithOrdinaryDividends": 360,
            "ordinaryDividendsAmount": 2500,
            "returnsWithQualifiedDividends": 340,
            "qualifiedDividendsAmount": 1645,
            "returnsStateLocalIncomeTaxRefunds": 40,
            "stateLocalIncomeTaxRefundAmount": 52,
            "returnsWithBusinessOrProfessionalNetIncome": 320,
            "businessOrProfessionalNetIncomeAmount": 4292,
            "returnsWithNetCapitalGain": 380,
            "netCapitalGainAmount": 3963,
            "returnsWithTaxableIraDistributions": 60,
            "taxableIradistributionAmount": 687,
            "returnsWithTaxablePensionsAnnuities": 60,
            "taxablePensionsAndAnnuitiesAmount": 833,
            "returnsFarms": 0,
            "returnsWithUnemploymentCompensation": 260,
            "unemploymentCompensationAmount": 4690,
            "returnsWithTaxableSocialSecurityBenefits": 150,
            "taxableSocialSecurityBenefitsAmount": 1233,
            "returnsWithPartnershipNetIncome": 170,
            "partnershipNetIncomeAmount": -1768,
            "returnsWithTotalStatutoryAdjustments": 320,
            "totalStatutoryAdjustmentsAmount": 1133,
            "returnsWithEducatorExpenses": 0,
            "educatorExpensesAmount": 0,
            "returnsWithSelfEmployedRetirementPlans": 0,
            "selfEmployedRetirementPlansAmount": 0,
            "returnsWithSelfEmployedHealthInsuranceDeduction": 70,
            "selfEmployedHealthInsuranceDeductionAmount": 443,
            "returnsWIthIraPayments": 30,
            "iraPaymentAmount": 177,
            "returnsWithStudenLoaninterestDeduction": 50,
            "studentLoaninterestDeductionAmount": 53,
            "returnsWithCharitableContributionsWithStandardDeductions": 280,
            "charitableContributionsWithStandardDeductionsAmount": 82,
            "returnsWithTotalStandardDeduction": 850,
            "standardDeductionAmount": 12282,
            "returnsWithBasicStandardDeduction": 850,
            "basicStandardDeductionAmount": 12064,
            "returnsWithAdditionalStandardDeduction": 120,
            "additionalStandardDeductionAmount": 218,
            "returnsWithItemizedDeductions": 160,
            "itemizedDeductionsAmount": 7030,
            "agiForItemizedReturnsAmount": 5775,
            "returnsWithTotalMedicalDentalDeduction": 80,
            "totalMedicalDentalDeductionAmount": 3382,
            "returnsWithStateAndLocalIncomeTaxes": 70,
            "stateAndLocalIncomeTaxesAmount": 600,
            "returnsWIthStateAndLocalGeneralSalesTax": 80,
            "stateAndLocalGeneralSalesTaxAmount": 64,
            "returnsWithRealEstateTaxes": 110,
            "realEstateTaxesAmount": 1689,
            "returnsWithPersonalPropertyTaxes": 50,
            "personalPropertyTaxesAmount": 23,
            "returnsWithLimitedStateLocalTaxes": 150,
            "limitedStateLocalTaxesAmount": 1055,
            "returnsWithTotalTaxesPaid": 160,
            "totalTaxesPaidAmount": 1051,
            "returnsWithHomeMortageInterestPaid": 80,
            "homeMortgageInterestPaidAmount": 1757,
            "returnsWithHomeMortgageFromPersonalSeller": 0,
            "homeMortgageFromPersonalSellerAmount": 0,
            "returnsWithDeductiblePoints": 30,
            "deductiblePointsAmount": 7,
            "returnsWithQualifiedMortgageInsurancePremiums": 0,
            "qualifiedMortgageInsurancePremiumsAmount": 0,
            "returnsWithInvestmentInterestPaid": 0,
            "investmentInterestPaidAmount": 0,
            "returnsWithTotalCharitableContributions": 90,
            "totalCharitableContributionsAmount": 379,
            "returnsWithOtherNonLimitedMiscDeductions": 0,
            "otherNonLimitedMiscDeductionsAmount": 0,
            "returnsWithQualifiedBusinessIncomeDeduction": 350,
            "qualifiedBusinessIncomeDeductionAmount": 781,
            "returnsWithTaxableIncome": 940,
            "taxableIncomeAmount": 19347,
            "returnsWithIncomeTaxBeforeCredits": 910,
            "incomeTaxBeforeCreditsAmount": 1986,
            "returnsWithAlternativeMinimumTax": 0,
            "alternativeMinimumTaxAmount": 0,
            "returnsWithExcessAdvancePremiumTaxCreditRepayment": 50,
            "excessAdvancePremiumTaxCreditRepaymentAmount": 29,
            "returnsWithTotalTaxCredits": 280,
            "totalTaxCreditsAmount": 202,
            "returnsWithForeignTaxCredit": 110,
            "foreignTaxCreditAmount": 17,
            "returnsWithChildAndDependentCareCredit": 0,
            "childAndDependentCareCreditAmount": 0,
            "returnsWithNonRefundableEducationCredit": 110,
            "nonRefundableEducationCreditAmount": 140,
            "returnsWithRetirementSavingsContributionCredit": 40,
            "retirementSavingsContributionCreditAmount": 7,
            "returnsWithChildAndOtherDependentCredit": 60,
            "childAndOtherDependentCreditAmount": 35,
            "returnsWithResidentialEnergyTaxCredit": 0,
            "residentialEnergyTaxCreditAmount": 0,
            "returnsWithSelfEmploymentTax": 270,
            "selfEmploymentTaxAmount": 812,
            "returnsWithTotalPremiumTaxCredit": 140,
            "totalPremiumTaxCreditAmount": 683,
            "returnsWithAdvancePremiumTaxCredit": 140,
            "advancePremiumTaxCreditAmount": 634,
            "returnsWithTotalTaxPayments": 840,
            "totalTaxPaymentsAmount": 4173,
            "returnsWithEarnedIncomeCredit": 70,
            "earnedIncomeCreditAmount": 142,
            "returnsWithExcessEarnedIncomeCredit": 40,
            "excessEarnedIncomeCreditAmount": 63,
            "returnsWithAdditionalChildTaxCredit": 80,
            "additionalChildTaxCreditAmount": 233,
            "returnsWithRefundableEducationCredit": 50,
            "refundableEducationCreditAmount": 44,
            "returnsWithNetPremiumTaxCredit": 80,
            "netPremiumTaxCreditAmount": 109,
            "returnsWithQualifiedSickAndFamilyLeaveCredit": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount": 0,
            "returnsWithRefundableChildAndDependentCredit": 0,
            "refundableChildAndDependentCareCreditAmount": 0,
            "returnsWithQualifiedSickAndFamilyLeaveCredit11530": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount11530": 0,
            "returnsWithRecoveryRebateCredit": 80,
            "recoveryRebateCreditAmount": 134,
            "returnsWithEconomicImpactPaymentFirstRound": 820,
            "economicImpactPaymentFirstRoundAmount": 1565,
            "returnsWitheconomicImpactPaymentSecondRound": 840,
            "economicImpactPaymentSecondRoundAmount": 1784,
            "returnsWithIncomeTaxAfterCredits": 880,
            "incomeTaxAfterCreditAmount": 2670,
            "returnsWithTaxLiability": 0,
            "taxLiabilityAmount": 0,
            "returnsWithAdditionalMedicareTax": 0,
            "additionalMedicareTaxAmount": 0,
            "returnsWithNetInvestmentIncomeTax": 370,
            "netInvestmentIncomeTaxAmount": 909,
            "returnsWithTaxDueAtTimeOfFiling": 600,
            "taxDueAtTimeOfFilingAmount": 2401,
            "returnsWithOverpaymentsRefunded": 510,
            "overpaymentRefundedAmount": 1665,
            "returnsWithCreditToNextYearTax": 120,
            "creditToNextYearTaxAmount": 736
        },
        {
            "zipCode": "90210",
            "year": 2021,
            "agiGroupId": "3",
            "agiGroup": "$50,000 under $75,000",
            "returns": 770,
            "singleReturns": 590,
            "jointReturns": 120,
            "headOfHouseholdReturns": 50,
            "electronicallyFilledReturns": 710,
            "computerPreparedPaperReturns": 30,
            "returnsWithPaidPreparedSignature": 600,
            "returnsWithDirectDeposit": 270,
            "returnsWithVirtualCurrency": 70,
            "numberOfIndividuals": 1020,
            "volunteerPreparedReturns": 0,
            "vitaPreparedReturns": 0,
            "tcePreparedReturns": 0,
            "eicVolunteerPreparedReturns": 0,
            "refundAnticipationCheckReturns": 40,
            "elderlyReturns": 220,
            "adjustedGrossIncome": 47867,
            "returnsWithTotalIncome": 770,
            "totalIncomeAmount": 49182,
            "returnsWithSalariesWages": 530,
            "salariesWagesAmount": 27100,
            "returnsWithTaxableinterest": 330,
            "taxableinterestAmount": 1184,
            "returnsWithOrdinaryDividends": 310,
            "ordinaryDividendsAmount": 2567,
            "returnsWithQualifiedDividends": 290,
            "qualifiedDividendsAmount": 1685,
            "returnsStateLocalIncomeTaxRefunds": 30,
            "stateLocalIncomeTaxRefundAmount": 37,
            "returnsWithBusinessOrProfessionalNetIncome": 210,
            "businessOrProfessionalNetIncomeAmount": 4471,
            "returnsWithNetCapitalGain": 330,
            "netCapitalGainAmount": 3868,
            "returnsWithTaxableIraDistributions": 60,
            "taxableIradistributionAmount": 743,
            "returnsWithTaxablePensionsAnnuities": 60,
            "taxablePensionsAndAnnuitiesAmount": 1643,
            "returnsFarms": 0,
            "returnsWithUnemploymentCompensation": 120,
            "unemploymentCompensationAmount": 2120,
            "returnsWithTaxableSocialSecurityBenefits": 150,
            "taxableSocialSecurityBenefitsAmount": 2621,
            "returnsWithPartnershipNetIncome": 160,
            "partnershipNetIncomeAmount": 1832,
            "returnsWithTotalStatutoryAdjustments": 240,
            "totalStatutoryAdjustmentsAmount": 1315,
            "returnsWithEducatorExpenses": 30,
            "educatorExpensesAmount": 6,
            "returnsWithSelfEmployedRetirementPlans": 20,
            "selfEmployedRetirementPlansAmount": 303,
            "returnsWithSelfEmployedHealthInsuranceDeduction": 80,
            "selfEmployedHealthInsuranceDeductionAmount": 466,
            "returnsWIthIraPayments": 40,
            "iraPaymentAmount": 299,
            "returnsWithStudenLoaninterestDeduction": 0,
            "studentLoaninterestDeductionAmount": 0,
            "returnsWithCharitableContributionsWithStandardDeductions": 250,
            "charitableContributionsWithStandardDeductionsAmount": 74,
            "returnsWithTotalStandardDeduction": 610,
            "standardDeductionAmount": 8916,
            "returnsWithBasicStandardDeduction": 610,
            "basicStandardDeductionAmount": 8736,
            "returnsWithAdditionalStandardDeduction": 100,
            "additionalStandardDeductionAmount": 180,
            "returnsWithItemizedDeductions": 160,
            "itemizedDeductionsAmount": 6309,
            "agiForItemizedReturnsAmount": 10110,
            "returnsWithTotalMedicalDentalDeduction": 90,
            "totalMedicalDentalDeductionAmount": 1875,
            "returnsWithStateAndLocalIncomeTaxes": 80,
            "stateAndLocalIncomeTaxesAmount": 1246,
            "returnsWIthStateAndLocalGeneralSalesTax": 70,
            "stateAndLocalGeneralSalesTaxAmount": 74,
            "returnsWithRealEstateTaxes": 120,
            "realEstateTaxesAmount": 2658,
            "returnsWithPersonalPropertyTaxes": 50,
            "personalPropertyTaxesAmount": 28,
            "returnsWithLimitedStateLocalTaxes": 160,
            "limitedStateLocalTaxesAmount": 1248,
            "returnsWithTotalTaxesPaid": 160,
            "totalTaxesPaidAmount": 1233,
            "returnsWithHomeMortageInterestPaid": 90,
            "homeMortgageInterestPaidAmount": 1986,
            "returnsWithHomeMortgageFromPersonalSeller": 0,
            "homeMortgageFromPersonalSellerAmount": 0,
            "returnsWithDeductiblePoints": 0,
            "deductiblePointsAmount": 0,
            "returnsWithQualifiedMortgageInsurancePremiums": 0,
            "qualifiedMortgageInsurancePremiumsAmount": 0,
            "returnsWithInvestmentInterestPaid": 30,
            "investmentInterestPaidAmount": 199,
            "returnsWithTotalCharitableContributions": 120,
            "totalCharitableContributionsAmount": 871,
            "returnsWithOtherNonLimitedMiscDeductions": 40,
            "otherNonLimitedMiscDeductionsAmount": 218,
            "returnsWithQualifiedBusinessIncomeDeduction": 280,
            "qualifiedBusinessIncomeDeductionAmount": 1145,
            "returnsWithTaxableIncome": 750,
            "taxableIncomeAmount": 32066,
            "returnsWithIncomeTaxBeforeCredits": 730,
            "incomeTaxBeforeCreditsAmount": 3854,
            "returnsWithAlternativeMinimumTax": 0,
            "alternativeMinimumTaxAmount": 0,
            "returnsWithExcessAdvancePremiumTaxCreditRepayment": 40,
            "excessAdvancePremiumTaxCreditRepaymentAmount": 57,
            "returnsWithTotalTaxCredits": 220,
            "totalTaxCreditsAmount": 195,
            "returnsWithForeignTaxCredit": 120,
            "foreignTaxCreditAmount": 39,
            "returnsWithChildAndDependentCareCredit": 0,
            "childAndDependentCareCreditAmount": 0,
            "returnsWithNonRefundableEducationCredit": 60,
            "nonRefundableEducationCreditAmount": 87,
            "returnsWithRetirementSavingsContributionCredit": 0,
            "retirementSavingsContributionCreditAmount": 0,
            "returnsWithChildAndOtherDependentCredit": 50,
            "childAndOtherDependentCreditAmount": 42,
            "returnsWithResidentialEnergyTaxCredit": 0,
            "residentialEnergyTaxCreditAmount": 0,
            "returnsWithSelfEmploymentTax": 180,
            "selfEmploymentTaxAmount": 831,
            "returnsWithTotalPremiumTaxCredit": 60,
            "totalPremiumTaxCreditAmount": 422,
            "returnsWithAdvancePremiumTaxCredit": 80,
            "advancePremiumTaxCreditAmount": 435,
            "returnsWithTotalTaxPayments": 670,
            "totalTaxPaymentsAmount": 5680,
            "returnsWithEarnedIncomeCredit": 0,
            "earnedIncomeCreditAmount": 0,
            "returnsWithExcessEarnedIncomeCredit": 0,
            "excessEarnedIncomeCreditAmount": 0,
            "returnsWithAdditionalChildTaxCredit": 50,
            "additionalChildTaxCreditAmount": 130,
            "returnsWithRefundableEducationCredit": 40,
            "refundableEducationCreditAmount": 39,
            "returnsWithNetPremiumTaxCredit": 50,
            "netPremiumTaxCreditAmount": 79,
            "returnsWithQualifiedSickAndFamilyLeaveCredit": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount": 0,
            "returnsWithRefundableChildAndDependentCredit": 0,
            "refundableChildAndDependentCareCreditAmount": 0,
            "returnsWithQualifiedSickAndFamilyLeaveCredit11530": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount11530": 0,
            "returnsWithRecoveryRebateCredit": 60,
            "recoveryRebateCreditAmount": 79,
            "returnsWithEconomicImpactPaymentFirstRound": 660,
            "economicImpactPaymentFirstRoundAmount": 1244,
            "returnsWitheconomicImpactPaymentSecondRound": 720,
            "economicImpactPaymentSecondRoundAmount": 3660,
            "returnsWithIncomeTaxAfterCredits": 730,
            "incomeTaxAfterCreditAmount": 4533,
            "returnsWithTaxLiability": 0,
            "taxLiabilityAmount": 0,
            "returnsWithAdditionalMedicareTax": 0,
            "additionalMedicareTaxAmount": 0,
            "returnsWithNetInvestmentIncomeTax": 330,
            "netInvestmentIncomeTaxAmount": 1310,
            "returnsWithTaxDueAtTimeOfFiling": 420,
            "taxDueAtTimeOfFilingAmount": 2445,
            "returnsWithOverpaymentsRefunded": 330,
            "overpaymentRefundedAmount": 1082,
            "returnsWithCreditToNextYearTax": 110,
            "creditToNextYearTaxAmount": 785
        },
        {
            "zipCode": "90210",
            "year": 2021,
            "agiGroupId": "4",
            "agiGroup": "$75,000 under $100,000",
            "returns": 580,
            "singleReturns": 380,
            "jointReturns": 130,
            "headOfHouseholdReturns": 40,
            "electronicallyFilledReturns": 530,
            "computerPreparedPaperReturns": 30,
            "returnsWithPaidPreparedSignature": 480,
            "returnsWithDirectDeposit": 170,
            "returnsWithVirtualCurrency": 50,
            "numberOfIndividuals": 850,
            "volunteerPreparedReturns": 0,
            "vitaPreparedReturns": 0,
            "tcePreparedReturns": 0,
            "eicVolunteerPreparedReturns": 0,
            "refundAnticipationCheckReturns": 0,
            "elderlyReturns": 200,
            "adjustedGrossIncome": 50044,
            "returnsWithTotalIncome": 580,
            "totalIncomeAmount": 51500,
            "returnsWithSalariesWages": 370,
            "salariesWagesAmount": 27281,
            "returnsWithTaxableinterest": 320,
            "taxableinterestAmount": 1139,
            "returnsWithOrdinaryDividends": 290,
            "ordinaryDividendsAmount": 2798,
            "returnsWithQualifiedDividends": 270,
            "qualifiedDividendsAmount": 1708,
            "returnsStateLocalIncomeTaxRefunds": 30,
            "stateLocalIncomeTaxRefundAmount": 50,
            "returnsWithBusinessOrProfessionalNetIncome": 150,
            "businessOrProfessionalNetIncomeAmount": 4208,
            "returnsWithNetCapitalGain": 300,
            "netCapitalGainAmount": 5798,
            "returnsWithTaxableIraDistributions": 80,
            "taxableIradistributionAmount": 2336,
            "returnsWithTaxablePensionsAnnuities": 70,
            "taxablePensionsAndAnnuitiesAmount": 2144,
            "returnsFarms": 0,
            "returnsWithUnemploymentCompensation": 80,
            "unemploymentCompensationAmount": 1201,
            "returnsWithTaxableSocialSecurityBenefits": 160,
            "taxableSocialSecurityBenefitsAmount": 3280,
            "returnsWithPartnershipNetIncome": 160,
            "partnershipNetIncomeAmount": -206,
            "returnsWithTotalStatutoryAdjustments": 160,
            "totalStatutoryAdjustmentsAmount": 1456,
            "returnsWithEducatorExpenses": 0,
            "educatorExpensesAmount": 0,
            "returnsWithSelfEmployedRetirementPlans": 0,
            "selfEmployedRetirementPlansAmount": 0,
            "returnsWithSelfEmployedHealthInsuranceDeduction": 60,
            "selfEmployedHealthInsuranceDeductionAmount": 561,
            "returnsWIthIraPayments": 0,
            "iraPaymentAmount": 0,
            "returnsWithStudenLoaninterestDeduction": 20,
            "studentLoaninterestDeductionAmount": 17,
            "returnsWithCharitableContributionsWithStandardDeductions": 190,
            "charitableContributionsWithStandardDeductionsAmount": 59,
            "returnsWithTotalStandardDeduction": 400,
            "standardDeductionAmount": 6131,
            "returnsWithBasicStandardDeduction": 400,
            "basicStandardDeductionAmount": 5989,
            "returnsWithAdditionalStandardDeduction": 80,
            "additionalStandardDeductionAmount": 142,
            "returnsWithItemizedDeductions": 170,
            "itemizedDeductionsAmount": 7788,
            "agiForItemizedReturnsAmount": 15327,
            "returnsWithTotalMedicalDentalDeduction": 90,
            "totalMedicalDentalDeductionAmount": 2441,
            "returnsWithStateAndLocalIncomeTaxes": 110,
            "stateAndLocalIncomeTaxesAmount": 1287,
            "returnsWIthStateAndLocalGeneralSalesTax": 70,
            "stateAndLocalGeneralSalesTaxAmount": 91,
            "returnsWithRealEstateTaxes": 140,
            "realEstateTaxesAmount": 3017,
            "returnsWithPersonalPropertyTaxes": 70,
            "personalPropertyTaxesAmount": 40,
            "returnsWithLimitedStateLocalTaxes": 170,
            "limitedStateLocalTaxesAmount": 1490,
            "returnsWithTotalTaxesPaid": 170,
            "totalTaxesPaidAmount": 1484,
            "returnsWithHomeMortageInterestPaid": 120,
            "homeMortgageInterestPaidAmount": 2580,
            "returnsWithHomeMortgageFromPersonalSeller": 0,
            "homeMortgageFromPersonalSellerAmount": 0,
            "returnsWithDeductiblePoints": 0,
            "deductiblePointsAmount": 0,
            "returnsWithQualifiedMortgageInsurancePremiums": 0,
            "qualifiedMortgageInsurancePremiumsAmount": 0,
            "returnsWithInvestmentInterestPaid": 40,
            "investmentInterestPaidAmount": 363,
            "returnsWithTotalCharitableContributions": 140,
            "totalCharitableContributionsAmount": 717,
            "returnsWithOtherNonLimitedMiscDeductions": 0,
            "otherNonLimitedMiscDeductionsAmount": 0,
            "returnsWithQualifiedBusinessIncomeDeduction": 250,
            "qualifiedBusinessIncomeDeductionAmount": 1248,
            "returnsWithTaxableIncome": 560,
            "taxableIncomeAmount": 35534,
            "returnsWithIncomeTaxBeforeCredits": 550,
            "incomeTaxBeforeCreditsAmount": 5030,
            "returnsWithAlternativeMinimumTax": 0,
            "alternativeMinimumTaxAmount": 0,
            "returnsWithExcessAdvancePremiumTaxCreditRepayment": 30,
            "excessAdvancePremiumTaxCreditRepaymentAmount": 62,
            "returnsWithTotalTaxCredits": 180,
            "totalTaxCreditsAmount": 151,
            "returnsWithForeignTaxCredit": 120,
            "foreignTaxCreditAmount": 56,
            "returnsWithChildAndDependentCareCredit": 0,
            "childAndDependentCareCreditAmount": 0,
            "returnsWithNonRefundableEducationCredit": 20,
            "nonRefundableEducationCreditAmount": 27,
            "returnsWithRetirementSavingsContributionCredit": 0,
            "retirementSavingsContributionCreditAmount": 0,
            "returnsWithChildAndOtherDependentCredit": 40,
            "childAndOtherDependentCreditAmount": 35,
            "returnsWithResidentialEnergyTaxCredit": 0,
            "residentialEnergyTaxCreditAmount": 0,
            "returnsWithSelfEmploymentTax": 130,
            "selfEmploymentTaxAmount": 788,
            "returnsWithTotalPremiumTaxCredit": 30,
            "totalPremiumTaxCreditAmount": 203,
            "returnsWithAdvancePremiumTaxCredit": 40,
            "advancePremiumTaxCreditAmount": 259,
            "returnsWithTotalTaxPayments": 510,
            "totalTaxPaymentsAmount": 6397,
            "returnsWithEarnedIncomeCredit": 0,
            "earnedIncomeCreditAmount": 0,
            "returnsWithExcessEarnedIncomeCredit": 0,
            "excessEarnedIncomeCreditAmount": 0,
            "returnsWithAdditionalChildTaxCredit": 60,
            "additionalChildTaxCreditAmount": 173,
            "returnsWithRefundableEducationCredit": 0,
            "refundableEducationCreditAmount": 0,
            "returnsWithNetPremiumTaxCredit": 0,
            "netPremiumTaxCreditAmount": 0,
            "returnsWithQualifiedSickAndFamilyLeaveCredit": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount": 0,
            "returnsWithRefundableChildAndDependentCredit": 0,
            "refundableChildAndDependentCareCreditAmount": 0,
            "returnsWithQualifiedSickAndFamilyLeaveCredit11530": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount11530": 0,
            "returnsWithRecoveryRebateCredit": 30,
            "recoveryRebateCreditAmount": 78,
            "returnsWithEconomicImpactPaymentFirstRound": 440,
            "economicImpactPaymentFirstRoundAmount": 929,
            "returnsWitheconomicImpactPaymentSecondRound": 540,
            "economicImpactPaymentSecondRoundAmount": 4878,
            "returnsWithIncomeTaxAfterCredits": 550,
            "incomeTaxAfterCreditAmount": 5723,
            "returnsWithTaxLiability": 0,
            "taxLiabilityAmount": 0,
            "returnsWithAdditionalMedicareTax": 0,
            "additionalMedicareTaxAmount": 0,
            "returnsWithNetInvestmentIncomeTax": 260,
            "netInvestmentIncomeTaxAmount": 1442,
            "returnsWithTaxDueAtTimeOfFiling": 310,
            "taxDueAtTimeOfFilingAmount": 2104,
            "returnsWithOverpaymentsRefunded": 230,
            "overpaymentRefundedAmount": 1367,
            "returnsWithCreditToNextYearTax": 90,
            "creditToNextYearTaxAmount": 737
        },
        {
            "zipCode": "90210",
            "year": 2021,
            "agiGroupId": "5",
            "agiGroup": "$100,000 under $200,000",
            "returns": 1360,
            "singleReturns": 720,
            "jointReturns": 510,
            "headOfHouseholdReturns": 80,
            "electronicallyFilledReturns": 1250,
            "computerPreparedPaperReturns": 60,
            "returnsWithPaidPreparedSignature": 1160,
            "returnsWithDirectDeposit": 340,
            "returnsWithVirtualCurrency": 120,
            "numberOfIndividuals": 2320,
            "volunteerPreparedReturns": 0,
            "vitaPreparedReturns": 0,
            "tcePreparedReturns": 0,
            "eicVolunteerPreparedReturns": 0,
            "refundAnticipationCheckReturns": 30,
            "elderlyReturns": 560,
            "adjustedGrossIncome": 195629,
            "returnsWithTotalIncome": 1360,
            "totalIncomeAmount": 200107,
            "returnsWithSalariesWages": 900,
            "salariesWagesAmount": 96896,
            "returnsWithTaxableinterest": 920,
            "taxableinterestAmount": 6105,
            "returnsWithOrdinaryDividends": 720,
            "ordinaryDividendsAmount": 11304,
            "returnsWithQualifiedDividends": 680,
            "qualifiedDividendsAmount": 7838,
            "returnsStateLocalIncomeTaxRefunds": 80,
            "stateLocalIncomeTaxRefundAmount": 160,
            "returnsWithBusinessOrProfessionalNetIncome": 320,
            "businessOrProfessionalNetIncomeAmount": 11014,
            "returnsWithNetCapitalGain": 790,
            "netCapitalGainAmount": 25373,
            "returnsWithTaxableIraDistributions": 250,
            "taxableIradistributionAmount": 9874,
            "returnsWithTaxablePensionsAnnuities": 190,
            "taxablePensionsAndAnnuitiesAmount": 9225,
            "returnsFarms": 0,
            "returnsWithUnemploymentCompensation": 160,
            "unemploymentCompensationAmount": 3059,
            "returnsWithTaxableSocialSecurityBenefits": 410,
            "taxableSocialSecurityBenefitsAmount": 10770,
            "returnsWithPartnershipNetIncome": 570,
            "partnershipNetIncomeAmount": 11293,
            "returnsWithTotalStatutoryAdjustments": 420,
            "totalStatutoryAdjustmentsAmount": 4478,
            "returnsWithEducatorExpenses": 0,
            "educatorExpensesAmount": 0,
            "returnsWithSelfEmployedRetirementPlans": 30,
            "selfEmployedRetirementPlansAmount": 652,
            "returnsWithSelfEmployedHealthInsuranceDeduction": 200,
            "selfEmployedHealthInsuranceDeductionAmount": 2044,
            "returnsWIthIraPayments": 50,
            "iraPaymentAmount": 404,
            "returnsWithStudenLoaninterestDeduction": 0,
            "studentLoaninterestDeductionAmount": 0,
            "returnsWithCharitableContributionsWithStandardDeductions": 410,
            "charitableContributionsWithStandardDeductionsAmount": 146,
            "returnsWithTotalStandardDeduction": 770,
            "standardDeductionAmount": 13349,
            "returnsWithBasicStandardDeduction": 770,
            "basicStandardDeductionAmount": 12949,
            "returnsWithAdditionalStandardDeduction": 200,
            "additionalStandardDeductionAmount": 400,
            "returnsWithItemizedDeductions": 590,
            "itemizedDeductionsAmount": 27197,
            "agiForItemizedReturnsAmount": 87581,
            "returnsWithTotalMedicalDentalDeduction": 220,
            "totalMedicalDentalDeductionAmount": 6543,
            "returnsWithStateAndLocalIncomeTaxes": 440,
            "stateAndLocalIncomeTaxesAmount": 7906,
            "returnsWIthStateAndLocalGeneralSalesTax": 140,
            "stateAndLocalGeneralSalesTaxAmount": 211,
            "returnsWithRealEstateTaxes": 470,
            "realEstateTaxesAmount": 10288,
            "returnsWithPersonalPropertyTaxes": 210,
            "personalPropertyTaxesAmount": 154,
            "returnsWithLimitedStateLocalTaxes": 580,
            "limitedStateLocalTaxesAmount": 5455,
            "returnsWithTotalTaxesPaid": 590,
            "totalTaxesPaidAmount": 5443,
            "returnsWithHomeMortageInterestPaid": 390,
            "homeMortgageInterestPaidAmount": 8849,
            "returnsWithHomeMortgageFromPersonalSeller": 0,
            "homeMortgageFromPersonalSellerAmount": 0,
            "returnsWithDeductiblePoints": 60,
            "deductiblePointsAmount": 28,
            "returnsWithQualifiedMortgageInsurancePremiums": 0,
            "qualifiedMortgageInsurancePremiumsAmount": 0,
            "returnsWithInvestmentInterestPaid": 110,
            "investmentInterestPaidAmount": 1175,
            "returnsWithTotalCharitableContributions": 480,
            "totalCharitableContributionsAmount": 4456,
            "returnsWithOtherNonLimitedMiscDeductions": 30,
            "otherNonLimitedMiscDeductionsAmount": 354,
            "returnsWithQualifiedBusinessIncomeDeduction": 690,
            "qualifiedBusinessIncomeDeductionAmount": 6186,
            "returnsWithTaxableIncome": 1340,
            "taxableIncomeAmount": 149340,
            "returnsWithIncomeTaxBeforeCredits": 1320,
            "incomeTaxBeforeCreditsAmount": 24453,
            "returnsWithAlternativeMinimumTax": 0,
            "alternativeMinimumTaxAmount": 0,
            "returnsWithExcessAdvancePremiumTaxCreditRepayment": 30,
            "excessAdvancePremiumTaxCreditRepaymentAmount": 136,
            "returnsWithTotalTaxCredits": 470,
            "totalTaxCreditsAmount": 719,
            "returnsWithForeignTaxCredit": 330,
            "foreignTaxCreditAmount": 314,
            "returnsWithChildAndDependentCareCredit": 0,
            "childAndDependentCareCreditAmount": 0,
            "returnsWithNonRefundableEducationCredit": 30,
            "nonRefundableEducationCreditAmount": 33,
            "returnsWithRetirementSavingsContributionCredit": 0,
            "retirementSavingsContributionCreditAmount": 0,
            "returnsWithChildAndOtherDependentCredit": 130,
            "childAndOtherDependentCreditAmount": 142,
            "returnsWithResidentialEnergyTaxCredit": 0,
            "residentialEnergyTaxCreditAmount": 0,
            "returnsWithSelfEmploymentTax": 280,
            "selfEmploymentTaxAmount": 2079,
            "returnsWithTotalPremiumTaxCredit": 50,
            "totalPremiumTaxCreditAmount": 371,
            "returnsWithAdvancePremiumTaxCredit": 60,
            "advancePremiumTaxCreditAmount": 445,
            "returnsWithTotalTaxPayments": 1260,
            "totalTaxPaymentsAmount": 28783,
            "returnsWithEarnedIncomeCredit": 0,
            "earnedIncomeCreditAmount": 0,
            "returnsWithExcessEarnedIncomeCredit": 0,
            "excessEarnedIncomeCreditAmount": 0,
            "returnsWithAdditionalChildTaxCredit": 180,
            "additionalChildTaxCreditAmount": 469,
            "returnsWithRefundableEducationCredit": 20,
            "refundableEducationCreditAmount": 15,
            "returnsWithNetPremiumTaxCredit": 30,
            "netPremiumTaxCreditAmount": 56,
            "returnsWithQualifiedSickAndFamilyLeaveCredit": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount": 0,
            "returnsWithRefundableChildAndDependentCredit": 30,
            "refundableChildAndDependentCareCreditAmount": 86,
            "returnsWithQualifiedSickAndFamilyLeaveCredit11530": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount11530": 0,
            "returnsWithRecoveryRebateCredit": 60,
            "recoveryRebateCreditAmount": 162,
            "returnsWithEconomicImpactPaymentFirstRound": 720,
            "economicImpactPaymentFirstRoundAmount": 1863,
            "returnsWitheconomicImpactPaymentSecondRound": 1300,
            "economicImpactPaymentSecondRoundAmount": 23734,
            "returnsWithIncomeTaxAfterCredits": 1310,
            "incomeTaxAfterCreditAmount": 26084,
            "returnsWithTaxLiability": 50,
            "taxLiabilityAmount": 37,
            "returnsWithAdditionalMedicareTax": 30,
            "additionalMedicareTaxAmount": 33,
            "returnsWithNetInvestmentIncomeTax": 660,
            "netInvestmentIncomeTaxAmount": 5665,
            "returnsWithTaxDueAtTimeOfFiling": 680,
            "taxDueAtTimeOfFilingAmount": 8312,
            "returnsWithOverpaymentsRefunded": 430,
            "overpaymentRefundedAmount": 3802,
            "returnsWithCreditToNextYearTax": 300,
            "creditToNextYearTaxAmount": 4510
        },
        {
            "zipCode": "90210",
            "year": 2021,
            "agiGroupId": "6",
            "agiGroup": "$200,000 or more",
            "returns": 3690,
            "singleReturns": 1010,
            "jointReturns": 2410,
            "headOfHouseholdReturns": 130,
            "electronicallyFilledReturns": 3440,
            "computerPreparedPaperReturns": 160,
            "returnsWithPaidPreparedSignature": 3500,
            "returnsWithDirectDeposit": 440,
            "returnsWithVirtualCurrency": 270,
            "numberOfIndividuals": 8320,
            "volunteerPreparedReturns": 0,
            "vitaPreparedReturns": 0,
            "tcePreparedReturns": 0,
            "eicVolunteerPreparedReturns": 0,
            "refundAnticipationCheckReturns": 0,
            "elderlyReturns": 1970,
            "adjustedGrossIncome": 6895478,
            "returnsWithTotalIncome": 3690,
            "totalIncomeAmount": 6952909,
            "returnsWithSalariesWages": 2560,
            "salariesWagesAmount": 1480370,
            "returnsWithTaxableinterest": 3270,
            "taxableinterestAmount": 137973,
            "returnsWithOrdinaryDividends": 2800,
            "ordinaryDividendsAmount": 427992,
            "returnsWithQualifiedDividends": 2680,
            "qualifiedDividendsAmount": 342569,
            "returnsStateLocalIncomeTaxRefunds": 110,
            "stateLocalIncomeTaxRefundAmount": 747,
            "returnsWithBusinessOrProfessionalNetIncome": 960,
            "businessOrProfessionalNetIncomeAmount": 159197,
            "returnsWithNetCapitalGain": 2990,
            "netCapitalGainAmount": 2587283,
            "returnsWithTaxableIraDistributions": 840,
            "taxableIradistributionAmount": 96512,
            "returnsWithTaxablePensionsAnnuities": 640,
            "taxablePensionsAndAnnuitiesAmount": 55520,
            "returnsFarms": 0,
            "returnsWithUnemploymentCompensation": 190,
            "unemploymentCompensationAmount": 2761,
            "returnsWithTaxableSocialSecurityBenefits": 1310,
            "taxableSocialSecurityBenefitsAmount": 42556,
            "returnsWithPartnershipNetIncome": 2710,
            "partnershipNetIncomeAmount": 1673951,
            "returnsWithTotalStatutoryAdjustments": 1580,
            "totalStatutoryAdjustmentsAmount": 57431,
            "returnsWithEducatorExpenses": 0,
            "educatorExpensesAmount": 0,
            "returnsWithSelfEmployedRetirementPlans": 290,
            "selfEmployedRetirementPlansAmount": 19869,
            "returnsWithSelfEmployedHealthInsuranceDeduction": 840,
            "selfEmployedHealthInsuranceDeductionAmount": 14925,
            "returnsWIthIraPayments": 150,
            "iraPaymentAmount": 1613,
            "returnsWithStudenLoaninterestDeduction": 0,
            "studentLoaninterestDeductionAmount": 0,
            "returnsWithCharitableContributionsWithStandardDeductions": 700,
            "charitableContributionsWithStandardDeductionsAmount": 306,
            "returnsWithTotalStandardDeduction": 1060,
            "standardDeductionAmount": 22317,
            "returnsWithBasicStandardDeduction": 1060,
            "basicStandardDeductionAmount": 21350,
            "returnsWithAdditionalStandardDeduction": 440,
            "additionalStandardDeductionAmount": 967,
            "returnsWithItemizedDeductions": 2630,
            "itemizedDeductionsAmount": 441660,
            "agiForItemizedReturnsAmount": 6038053,
            "returnsWithTotalMedicalDentalDeduction": 260,
            "totalMedicalDentalDeductionAmount": 16526,
            "returnsWithStateAndLocalIncomeTaxes": 2430,
            "stateAndLocalIncomeTaxesAmount": 664592,
            "returnsWIthStateAndLocalGeneralSalesTax": 190,
            "stateAndLocalGeneralSalesTaxAmount": 415,
            "returnsWithRealEstateTaxes": 2360,
            "realEstateTaxesAmount": 106368,
            "returnsWithPersonalPropertyTaxes": 970,
            "personalPropertyTaxesAmount": 1147,
            "returnsWithLimitedStateLocalTaxes": 2620,
            "limitedStateLocalTaxesAmount": 26099,
            "returnsWithTotalTaxesPaid": 2630,
            "totalTaxesPaidAmount": 27956,
            "returnsWithHomeMortageInterestPaid": 1940,
            "homeMortgageInterestPaidAmount": 45108,
            "returnsWithHomeMortgageFromPersonalSeller": 80,
            "homeMortgageFromPersonalSellerAmount": 1654,
            "returnsWithDeductiblePoints": 260,
            "deductiblePointsAmount": 233,
            "returnsWithQualifiedMortgageInsurancePremiums": 0,
            "qualifiedMortgageInsurancePremiumsAmount": 0,
            "returnsWithInvestmentInterestPaid": 1080,
            "investmentInterestPaidAmount": 91665,
            "returnsWithTotalCharitableContributions": 2430,
            "totalCharitableContributionsAmount": 247005,
            "returnsWithOtherNonLimitedMiscDeductions": 370,
            "otherNonLimitedMiscDeductionsAmount": 9769,
            "returnsWithQualifiedBusinessIncomeDeduction": 2520,
            "qualifiedBusinessIncomeDeductionAmount": 218050,
            "returnsWithTaxableIncome": 3670,
            "taxableIncomeAmount": 6219814,
            "returnsWithIncomeTaxBeforeCredits": 3670,
            "incomeTaxBeforeCreditsAmount": 1706059,
            "returnsWithAlternativeMinimumTax": 240,
            "alternativeMinimumTaxAmount": 5716,
            "returnsWithExcessAdvancePremiumTaxCreditRepayment": 30,
            "excessAdvancePremiumTaxCreditRepaymentAmount": 140,
            "returnsWithTotalTaxCredits": 1900,
            "totalTaxCreditsAmount": 34255,
            "returnsWithForeignTaxCredit": 1640,
            "foreignTaxCreditAmount": 25608,
            "returnsWithChildAndDependentCareCredit": 0,
            "childAndDependentCareCreditAmount": 0,
            "returnsWithNonRefundableEducationCredit": 0,
            "nonRefundableEducationCreditAmount": 0,
            "returnsWithRetirementSavingsContributionCredit": 0,
            "retirementSavingsContributionCreditAmount": 0,
            "returnsWithChildAndOtherDependentCredit": 130,
            "childAndOtherDependentCreditAmount": 116,
            "returnsWithResidentialEnergyTaxCredit": 60,
            "residentialEnergyTaxCreditAmount": 657,
            "returnsWithSelfEmploymentTax": 1120,
            "selfEmploymentTaxAmount": 25551,
            "returnsWithTotalPremiumTaxCredit": 0,
            "totalPremiumTaxCreditAmount": 0,
            "returnsWithAdvancePremiumTaxCredit": 30,
            "advancePremiumTaxCreditAmount": 221,
            "returnsWithTotalTaxPayments": 3580,
            "totalTaxPaymentsAmount": 1928618,
            "returnsWithEarnedIncomeCredit": 0,
            "earnedIncomeCreditAmount": 0,
            "returnsWithExcessEarnedIncomeCredit": 0,
            "excessEarnedIncomeCreditAmount": 0,
            "returnsWithAdditionalChildTaxCredit": 240,
            "additionalChildTaxCreditAmount": 422,
            "returnsWithRefundableEducationCredit": 0,
            "refundableEducationCreditAmount": 0,
            "returnsWithNetPremiumTaxCredit": 0,
            "netPremiumTaxCreditAmount": 0,
            "returnsWithQualifiedSickAndFamilyLeaveCredit": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount": 0,
            "returnsWithRefundableChildAndDependentCredit": 30,
            "refundableChildAndDependentCareCreditAmount": 36,
            "returnsWithQualifiedSickAndFamilyLeaveCredit11530": 0,
            "qualifiedSickAndFamilyLeaveCreditAmount11530": 0,
            "returnsWithRecoveryRebateCredit": 0,
            "recoveryRebateCreditAmount": 0,
            "returnsWithEconomicImpactPaymentFirstRound": 590,
            "economicImpactPaymentFirstRoundAmount": 1709,
            "returnsWitheconomicImpactPaymentSecondRound": 3650,
            "economicImpactPaymentSecondRoundAmount": 1671803,
            "returnsWithIncomeTaxAfterCredits": 3690,
            "incomeTaxAfterCreditAmount": 1810055,
            "returnsWithTaxLiability": 1660,
            "taxLiabilityAmount": 12368,
            "returnsWithAdditionalMedicareTax": 2980,
            "additionalMedicareTaxAmount": 93797,
            "returnsWithNetInvestmentIncomeTax": 1630,
            "netInvestmentIncomeTaxAmount": 164179,
            "returnsWithTaxDueAtTimeOfFiling": 2050,
            "taxDueAtTimeOfFilingAmount": 280919,
            "returnsWithOverpaymentsRefunded": 620,
            "overpaymentRefundedAmount": 43208,
            "returnsWithCreditToNextYearTax": 1570,
            "creditToNextYearTaxAmount": 237711
        }
    ]
}

Conclusion: Leveraging Zip Code Data for Targeted Marketing

In a world where data-driven decisions are key to success, zip code statistics based on IRS data offer a significant competitive edge. Businesses that utilize these insights can craft more personalized and effective marketing campaigns, ensuring their efforts resonate with the right audience in the right location.

With the ability to access this data through an intuitive API, companies of all sizes can now tap into the power of zip code statistics for market analysis and targeted marketing. Whether you’re looking to improve customer targeting, boost ROI, or tailor your products to the needs of specific regions, leveraging IRS data is the smart way to stay ahead in today’s competitive market.

Embrace the power of zip code statistics today, and let IRS data drive your next successful marketing campaign!

This blog post introduces the immense potential of zip code statistics for business analysis, highlighting how leveraging IRS data through an API can enable smarter, targeted marketing decisions.

Getting Income Statistics by Zip Code

Sat, 22 Jun 2024 14:49:00 GMT

Introduction

Understanding the income statistics of specific areas can be incredibly valuable for businesses, researchers, and policymakers. Detailed income data by zip code can offer insights into economic conditions, consumer behavior, and regional disparities. Thanks to the Zip Code API by Metadapi, getting access to detailed statistics and utilizing this data has never been easier. In this blog post, we'll explore how to obtain income statistics by zip code, highlight some sample use cases, and delve into one detailed use case to illustrate its practical application.

Understanding Income Statistics API

The statistics of income endpoint from the Zip Code API offer a wealth of data, including median household income, per capita income, income distribution, total returns, and much more (Over 160 data points). This API reconciles data from the "Individual Income Tax Statistics" dataset provided by the IRS. We provide a consolidated view into this dataset to ensure accuracy and comprehensiveness. By using this API, users can easily integrate income statistics data into their applications, websites, or research projects.

Sample Use Cases for Income Statistics by Zip Code

Business Market Analysis: Businesses can use income data to identify potential markets, tailor marketing strategies, and make informed decisions about store locations.
Real Estate Investment: Real estate investors can assess neighborhood affluence to determine property values and investment potential.
Public Policy and Planning: Policymakers can analyze income disparities across regions to allocate resources and design programs aimed at reducing poverty.
Academic Research: Researchers can study the correlation between income levels and various social factors, such as education and health outcomes.
Nonprofit Fundraising: Nonprofit organizations can identify areas with lower income levels to target for fundraising and outreach programs.

Detailed Use Case: Business Market Analysis

Let's dive deeper into how a retail business might use income statistics by zip code to enhance its market analysis and decision-making process.

Scenario: Opening a New Retail Store

Objective: A retail chain wants to open a new store in a metropolitan area. They need to determine the best location based on the income levels of different neighborhoods to ensure profitability and sustainability.

Steps:

Identify Potential Locations: The business identifies several zip codes in the metropolitan area where they might open the new store.
Retrieve Income Data: Using an income statistics API, the business retrieves detailed income data for each identified zip code. The API provides information such as median household income, income distribution.
Analyze Data: The business analyzes the retrieved data to compare the economic conditions of the different zip codes. They focus on metrics such as higher median household income and lower poverty rates, which indicate greater purchasing power and economic stability.
Determine Target Demographics: The business identifies the target demographics that align with their products and services. For example, if they sell high-end electronics, they might prioritize areas with higher income levels.
Make Informed Decision: Based on the income data analysis, the business selects the zip code with the most favorable economic conditions for their new store. They also use the data to tailor their marketing strategies, such as offering promotions that appeal to higher-income customers.
Monitor and Adjust: After opening the store, the business continues to monitor income data and other economic indicators. They use this ongoing data analysis to adjust their strategies and operations to maximize profitability.

As an example, let's use the following Python code to extract and save into a csv file the number of returns and wages for 3 zip codes.

import requests
import csv

zips = ['33009','33967','90210']
file = r'<>'

def fetch_data_from_api(zipCode):
#Replace the string with a valid metadapi.com API key.
vheaders = {"Ocp-Apim-Subscription-Key": "<>"}
url = f"https://global.metadapi.com/zipc/v1/zipcodes/{zipCode}/soi"
response = requests.get(url,headers=vheaders)
if response.status_code == 200:
return response.json()
else:
print(f"Failed to fetch data. Status code: {response.status_code}")
return None

def main():
with open(file, 'w', newline='') as zipfile:
writer = csv.writer(zipfile)
header = ['zipCode', 'year', 'agiGroupId', 'returns', 'salariesWagesAmount']
writer.writerow(header)
for zip in zips :
try:
response_api_data = fetch_data_from_api(zip)
print('called api with success')
for data in response_api_data['data']:
row = [data['zipCode'], data['year'], data['agiGroupId'], data['returns'],data['salariesWagesAmount']]
writer.writerow(row)
except:
print('There was an exception calling the API.')

if __name__ == "__main__":
main()

This code will save a csv file with the returns and wages for the zip code provided. Check out the full zip code statistics of income schema and take advantage of the hundreds of data elements available for analysis and application development.

Using your favorite data reporting tool (Excel, PowerBI, Tableau, etc.) create a visualization that will help in your analysis of the extracted data.

Conclusion

Income statistics by zip code provide a granular view of economic conditions, enabling businesses, policymakers, and researchers to make data-driven decisions. By leveraging the Zip Code API that offers detailed income data, users can gain valuable insights into local economies, tailor their strategies, and achieve their objectives more effectively. Whether you're opening a new store, investing in real estate, or designing public policies, understanding income statistics at the zip code level can significantly enhance your decision-making process.

Maximizing Efficiency: Calling APIs in Parallel

Wed, 17 Apr 2024 23:53:53 GMT

Understanding Parallel API Calls

Traditionally, API calls are executed sequentially, meaning that each call is made one after the other, with subsequent calls waiting for the previous one to complete. While this approach may suffice for small-scale applications, it can lead to significant performance bottlenecks as the number of API calls increases.

Parallel API calls, on the other hand, involve making multiple API requests concurrently, allowing them to execute simultaneously. This approach harnesses the full potential of modern computing systems, significantly reducing the overall latency and improving throughput.

Example Use Cases

Fetching Data from Multiple Sources:
Imagine you're building a data aggregation platform that gathers information from various external APIs. Instead of waiting for each API call to finish sequentially, you can execute them in parallel. This approach minimizes the time required to collect the data, providing users with real-time or near-real-time updates.
Processing Large Datasets:
When dealing with large datasets that require extensive processing, parallel API calls can significantly expedite the task. For instance, in data analysis applications, you may need to retrieve data from multiple sources, perform computations, and then consolidate the results. By making concurrent API calls, you can distribute the workload across multiple threads or processes, accelerating the overall processing time.
Microservices Architecture:
In microservices-based architectures, where applications are composed of loosely-coupled, independently deployable services, parallel API calls are instrumental. Each microservice often relies on several other services to fulfill its functionalities. By making concurrent API requests, microservices can operate more autonomously, reducing dependencies and improving overall system resilience.
Web Scraping and Crawling: Web scraping and crawling applications often require fetching data from numerous web pages or APIs. Parallel API calls enable faster data retrieval, enabling developers to harvest large amounts of information efficiently. Whether it's monitoring competitors' prices, gathering news articles, or extracting product details, parallelization can significantly enhance the performance of web scraping tasks.

Implementing Parallel API Calls

Implementing parallel API calls involves leveraging concurrency mechanisms provided by programming languages or frameworks. Python, for instance, offers libraries such as `concurrent.futures` and `asyncio`, which facilitate concurrent execution of tasks.

Below is an example demonstrating how to call APIs in parallel using Python's `concurrent.futures` module:

import requests
import concurrent.futures

# Function to fetch description for a single zipcode
def fetch_description(vzipcode):
    vheaders = {"Ocp-Apim-Subscription-Key": ""} #CHANGE TO INCLUDE API KEY PROVIDED BY METADAPI.COM
    url = f"https://global.metadapi.com/zipc/v1/zipcodes/{vzipcode}"
    response = requests.get(url, headers=vheaders)
    if response.status_code == 200:
        return response.json()
    else:
        return None

# Function to process codes in parallel
def process_codes_in_parallel(zipcodes):
    descriptions = []
    with concurrent.futures.ThreadPoolExecutor(max_workers=2) as executor:
        future_to_code = {executor.submit(fetch_description, zipcode): zipcode for zipcode in zipcodes}
        for future in concurrent.futures.as_completed(future_to_code):
            zipcode = future_to_code[future]
            try:
                description = future.result()
                if description:
                    descriptions.append(description)
            except Exception as e:
                print(f"Failed to fetch description for code {zipcode}: {e}")
    return descriptions

# Read codes from a file
def read_codes_from_file(filename):
    with open(filename, 'r') as file:
        zipcodes = [line.strip() for line in file]
    return zipcodes

# Main function
def main():
    filename = r'sample-zips.txt'  #CHANGE TO INCLUDE PATH AND FILE NAME IN LOCAL ENVIRONMENT
    zipcodes = read_codes_from_file(filename)
    
    # Process codes in chunks
    chunk_size = 2
    for i in range(0, len(zipcodes), chunk_size):
        chunk = zipcodes[i:i+chunk_size]
        descriptions = process_codes_in_parallel(chunk)
        print(descriptions)  # Do whatever you want with the descriptions

if __name__ == "__main__":
    main()

Conclusion

Calling APIs in parallel is a powerful technique for optimizing performance and scalability in modern applications. By distributing workloads across multiple concurrent tasks, developers can reduce latency, improve throughput, and enhance the overall user experience. Whether it's aggregating data from disparate sources, processing large datasets, or building resilient microservices architectures, parallel API calls offer a robust solution to meet the demands of today's interconnected world.

MSA Codes by Zip Code for Targeted Data Insights

Sat, 02 Mar 2024 20:20:58 GMT

Understanding MSA - Metropolitan Statistical Area

In the context of statistical areas, MSA stands for Metropolitan Statistical Area, and it is a designation used by the U.S. Office of Management and Budget (OMB) for a geographical region with a relatively high population density at its core and close economic ties throughout the area. MSAs are commonly used for statistical and economic analysis.

The following concepts are important to understand how these work:

Metropolitan Statistical Area (MSA):
- Purpose: The primary purpose of an MSA is to define and delineate metropolitan regions for statistical and administrative purposes. MSAs help in understanding and analyzing demographic, economic, and social trends within urban areas and their surrounding regions.

- Criteria: MSAs are defined based on factors such as population density, commuting patterns, and economic integration. A core urban area with a certain population size and strong economic ties to surrounding counties may be designated as an MSA.

- Components: An MSA typically consists of a central city or cities and surrounding counties that are economically and socially integrated with the urban core.

Micro Statistical Area (μSA):
- Purpose: Micro Statistical Areas are smaller geographical areas that are also designated by the OMB for statistical and administrative purposes. They are similar to MSAs but represent smaller urban clusters.

- Criteria: The criteria for defining Micro Statistical Areas are similar to those for MSAs but with lower population thresholds. They are areas with a core urban center and adjacent counties that exhibit economic and social ties to the urban core.

- Components: A Micro Statistical Area includes a core urban area and its closely associated counties, similar to an MSA but on a smaller scale.

In summary, both MSAs and Micro Statistical Areas are designed to provide a framework for analyzing and understanding demographic, economic, and social trends in urban and surrounding regions. MSAs are larger and encompass major metropolitan regions, while Micro Statistical Areas are smaller clusters with similar characteristics. These designations facilitate consistent and standardized reporting and analysis of data at different geographic scales.

MSA Use Cases

The US Zip Code API by Metadapi, can return all zip codes associated with a Metropolitan Statistical Area (MSA). This dataset can be valuable for various use cases, enabling developers and businesses to leverage the geographic and demographic information tied to specific urban regions. Here are some potential use cases:

1. Targeted Marketing Campaigns:
- Businesses can use the zip code information to target their marketing campaigns more effectively. They can tailor promotions, advertisements, and communications specifically for residents within the identified MSA.

2. Localized Services and Retail Planning:
- Retailers and service providers can use the zip code data to plan and optimize their locations. Understanding the distribution of zip codes within an MSA helps in selecting suitable locations for stores, offices, or service centers.

3. Demographic Analysis:
- Researchers and analysts can use the zip code information to conduct demographic studies within an MSA. This includes understanding population density, income levels, and other socio-economic factors associated with specific zip codes.

4. Real Estate and Property Analysis:
- The API can be utilized by real estate professionals to assess property trends and demand in different zip codes within an MSA. It can aid in making informed decisions regarding property investments, development, and pricing strategies.

5. Logistics and Delivery Optimization:
- Companies involved in logistics and delivery services can optimize their routes and operations by understanding the distribution of zip codes within an MSA. This can lead to more efficient delivery schedules and reduced operational costs.

6. Social and Community Services Planning:
- Government agencies and non-profit organizations can use the zip code data to plan and allocate resources for social and community services. Understanding the geographic distribution helps in identifying areas with specific needs.

7. Insurance and Risk Assessment:
- Insurance companies can utilize the information to assess risk factors associated with different zip codes within an MSA. This can be beneficial in determining insurance premiums and managing risk portfolios.

8. Education Planning:
- Educational institutions and policymakers can analyze zip code data to plan educational programs and resource allocation. It helps in understanding the distribution of student populations and educational needs within an MSA.

9. Travel and Tourism Planning:
- The zip code data can be used in the travel and tourism industry to plan marketing strategies and identify areas of interest within an MSA. This can help in promoting local attractions and services.

10. Emergency Services Planning:
- Emergency services can benefit from understanding the distribution of population across zip codes within an MSA. This information can aid in disaster response planning, resource allocation, and emergency services optimization.

Sample API calls

All zip codes for the Dallas-Fort Worth-Arlington metropolitan area

You can view a list of MSA Codes in Texas by using the Get MSA Groups endpoint.

GET https://global.metadapi.com/zipc/v2/msagroups?statecode=tx

The MSA code for the Dallas-Fort Worth-Arlington is 19100, we use this to get a full list of zip codes in that metropolitan area:

GET https://global.metadapi.com/zipc/v2/zipcodes?msacode=19100

This returns the full list of zip codes related to this MSA (409 total), for example zip codes 75001, 75002, 75006, 75007, 75009 and 75010.

{
    "links": {
        "self": "/zipc/v2/zipcodes?msacode=19100?limit=10&offset=0&msacode=19100",
        "first": "/zipc/v2/zipcodes?msacode=19100?limit=10&offset=0&msacode=19100",
        "next": "/zipc/v2/zipcodes?msacode=19100?limit=10&offset=10&msacode=19100"
    },
    "meta": {
        "count": 409,
        "offset": 0,
        "limit": 10
    },
    "data": [
        {
            "zipCode": "75001",
            "uspsMainCityKey": "W22681",
            "uspsMainCityName": "ADDISON",
            "titleCaseCityName": "Addison",
            "zipClassificationCode": "N",
            "zipClassificationDesc": "Non-Unique Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "D",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Do Not Apply-Merging Not Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "480055",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "113",
            "uspsCountyName": "DALLAS",
            "titleCaseCountyName": "Dallas",
            "latitude": 32.96005,
            "longitude": -96.838524,
            "landAreaMi2": 3.828,
            "waterAreaMi2": 0.003,
            "landAreaKm2": 9.915172,
            "waterAreaKm2": 0.008702,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W22681",
                    "uspsCityName": "ADDISON",
                    "titleCaseCityName": "Addison",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                }
            ],
            "zipCodeStatistics": [
                {
                    "year": 2000,
                    "totalPopulation": 8259,
                    "malePopulation": 4258,
                    "femalePopulation": 4001
                },
                {
                    "year": 2010,
                    "totalPopulation": 12414,
                    "malePopulation": 6185,
                    "femalePopulation": 6229
                },
                {
                    "year": 2020,
                    "totalPopulation": 16528,
                    "malePopulation": 8148,
                    "femalePopulation": 8380
                }
            ]
        },
        {
            "zipCode": "75002",
            "uspsMainCityKey": "W22717",
            "uspsMainCityName": "ALLEN",
            "titleCaseCityName": "Allen",
            "zipClassificationCode": "N",
            "zipClassificationDesc": "Non-Unique Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "B",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Apply-Merging Not Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "480160",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "085",
            "uspsCountyName": "COLLIN",
            "titleCaseCountyName": "Collin",
            "latitude": 33.089855,
            "longitude": -96.6086,
            "landAreaMi2": 37.2,
            "waterAreaMi2": 2.042,
            "landAreaKm2": 96.34764,
            "waterAreaKm2": 5.28926,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W22717",
                    "uspsCityName": "ALLEN",
                    "titleCaseCityName": "Allen",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                },
                {
                    "uspsCityKey": "011291",
                    "uspsCityName": "LUCAS",
                    "titleCaseCityName": "Lucas",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": false
                },
                {
                    "uspsCityKey": "013120",
                    "uspsCityName": "PARKER",
                    "titleCaseCityName": "Parker",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": false
                }
            ],
            "zipCodeStatistics": [
                {
                    "year": 2000,
                    "totalPopulation": 37216,
                    "malePopulation": 18588,
                    "femalePopulation": 18628
                },
                {
                    "year": 2010,
                    "totalPopulation": 63140,
                    "malePopulation": 31093,
                    "femalePopulation": 32047
                },
                {
                    "year": 2020,
                    "totalPopulation": 69939,
                    "malePopulation": 34410,
                    "femalePopulation": 35529
                }
            ]
        },
        {
            "zipCode": "75006",
            "uspsMainCityKey": "W23158",
            "uspsMainCityName": "CARROLLTON",
            "titleCaseCityName": "Carrollton",
            "zipClassificationCode": "N",
            "zipClassificationDesc": "Non-Unique Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "D",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Do Not Apply-Merging Not Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "481475",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "113",
            "uspsCountyName": "DALLAS",
            "titleCaseCountyName": "Dallas",
            "latitude": 32.96214,
            "longitude": -96.89858,
            "landAreaMi2": 16.801,
            "waterAreaMi2": 0.327,
            "landAreaKm2": 43.51386,
            "waterAreaKm2": 0.846029,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W23158",
                    "uspsCityName": "CARROLLTON",
                    "titleCaseCityName": "Carrollton",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                }
            ],
            "zipCodeStatistics": [
                {
                    "year": 2000,
                    "totalPopulation": 46784,
                    "malePopulation": 23353,
                    "femalePopulation": 23431
                },
                {
                    "year": 2010,
                    "totalPopulation": 46364,
                    "malePopulation": 23012,
                    "femalePopulation": 23352
                },
                {
                    "year": 2020,
                    "totalPopulation": 47811,
                    "malePopulation": 23653,
                    "femalePopulation": 24158
                }
            ]
        },
        {
            "zipCode": "75007",
            "uspsMainCityKey": "W23158",
            "uspsMainCityName": "CARROLLTON",
            "titleCaseCityName": "Carrollton",
            "zipClassificationCode": "N",
            "zipClassificationDesc": "Non-Unique Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "B",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Apply-Merging Not Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "481475",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "121",
            "uspsCountyName": "DENTON",
            "titleCaseCountyName": "Denton",
            "latitude": 33.00526,
            "longitude": -96.89674,
            "landAreaMi2": 11.749,
            "waterAreaMi2": 0.121,
            "landAreaKm2": 30.430355,
            "waterAreaKm2": 0.31431,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W23158",
                    "uspsCityName": "CARROLLTON",
                    "titleCaseCityName": "Carrollton",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                }
            ],
            "zipCodeStatistics": [
                {
                    "year": 2000,
                    "totalPopulation": 49933,
                    "malePopulation": 24616,
                    "femalePopulation": 25317
                },
                {
                    "year": 2010,
                    "totalPopulation": 51624,
                    "malePopulation": 25189,
                    "femalePopulation": 26435
                },
                {
                    "year": 2020,
                    "totalPopulation": 53960,
                    "malePopulation": 26394,
                    "femalePopulation": 27566
                }
            ]
        },
        {
            "zipCode": "75009",
            "uspsMainCityKey": "W23189",
            "uspsMainCityName": "CELINA",
            "titleCaseCityName": "Celina",
            "zipClassificationCode": "N",
            "zipClassificationDesc": "Non-Unique Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "D",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Do Not Apply-Merging Not Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "481585",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "085",
            "uspsCountyName": "COLLIN",
            "titleCaseCountyName": "Collin",
            "latitude": 33.338898,
            "longitude": -96.752975,
            "landAreaMi2": 95.612,
            "waterAreaMi2": 1.433,
            "landAreaKm2": 247.63293,
            "waterAreaKm2": 3.711938,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W23189",
                    "uspsCityName": "CELINA",
                    "titleCaseCityName": "Celina",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                }
            ],
            "zipCodeStatistics": [
                {
                    "year": 2000,
                    "totalPopulation": 4951,
                    "malePopulation": 2523,
                    "femalePopulation": 2428
                },
                {
                    "year": 2010,
                    "totalPopulation": 8785,
                    "malePopulation": 4385,
                    "femalePopulation": 4400
                },
                {
                    "year": 2020,
                    "totalPopulation": 21276,
                    "malePopulation": 10605,
                    "femalePopulation": 10671
                }
            ]
        },
        {
            "zipCode": "75014",
            "uspsMainCityKey": "W24197",
            "uspsMainCityName": "IRVING",
            "titleCaseCityName": "Irving",
            "zipClassificationCode": "P",
            "zipClassificationDesc": "PO Box Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "C",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Do Not Apply-Merging Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "484360",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "113",
            "uspsCountyName": "DALLAS",
            "titleCaseCountyName": "Dallas",
            "latitude": null,
            "longitude": null,
            "landAreaMi2": null,
            "waterAreaMi2": null,
            "landAreaKm2": null,
            "waterAreaKm2": null,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W24197",
                    "uspsCityName": "IRVING",
                    "titleCaseCityName": "Irving",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                }
            ],
            "zipCodeStatistics": null
        },
        {
            "zipCode": "75011",
            "uspsMainCityKey": "W23158",
            "uspsMainCityName": "CARROLLTON",
            "titleCaseCityName": "Carrollton",
            "zipClassificationCode": "P",
            "zipClassificationDesc": "PO Box Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "D",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Do Not Apply-Merging Not Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "481475",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "113",
            "uspsCountyName": "DALLAS",
            "titleCaseCountyName": "Dallas",
            "latitude": null,
            "longitude": null,
            "landAreaMi2": null,
            "waterAreaMi2": null,
            "landAreaKm2": null,
            "waterAreaKm2": null,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W23158",
                    "uspsCityName": "CARROLLTON",
                    "titleCaseCityName": "Carrollton",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                }
            ],
            "zipCodeStatistics": null
        },
        {
            "zipCode": "75010",
            "uspsMainCityKey": "W23158",
            "uspsMainCityName": "CARROLLTON",
            "titleCaseCityName": "Carrollton",
            "zipClassificationCode": "N",
            "zipClassificationDesc": "Non-Unique Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "B",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Apply-Merging Not Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "481475",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "121",
            "uspsCountyName": "DENTON",
            "titleCaseCountyName": "Denton",
            "latitude": 33.049965,
            "longitude": -96.87302,
            "landAreaMi2": 8.082,
            "waterAreaMi2": 0.065,
            "landAreaKm2": 20.933289,
            "waterAreaKm2": 0.168897,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W23158",
                    "uspsCityName": "CARROLLTON",
                    "titleCaseCityName": "Carrollton",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                }
            ],
            "zipCodeStatistics": [
                {
                    "year": 2000,
                    "totalPopulation": 13202,
                    "malePopulation": 6463,
                    "femalePopulation": 6739
                },
                {
                    "year": 2010,
                    "totalPopulation": 21607,
                    "malePopulation": 10257,
                    "femalePopulation": 11350
                },
                {
                    "year": 2020,
                    "totalPopulation": 33186,
                    "malePopulation": 15834,
                    "femalePopulation": 17352
                }
            ]
        },
        {
            "zipCode": "75017",
            "uspsMainCityKey": "W24197",
            "uspsMainCityName": "IRVING",
            "titleCaseCityName": "Irving",
            "zipClassificationCode": "P",
            "zipClassificationDesc": "PO Box Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "C",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Do Not Apply-Merging Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "484360",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "113",
            "uspsCountyName": "DALLAS",
            "titleCaseCountyName": "Dallas",
            "latitude": null,
            "longitude": null,
            "landAreaMi2": null,
            "waterAreaMi2": null,
            "landAreaKm2": null,
            "waterAreaKm2": null,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W24197",
                    "uspsCityName": "IRVING",
                    "titleCaseCityName": "Irving",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                }
            ],
            "zipCodeStatistics": null
        },
        {
            "zipCode": "75015",
            "uspsMainCityKey": "W24197",
            "uspsMainCityName": "IRVING",
            "titleCaseCityName": "Irving",
            "zipClassificationCode": "P",
            "zipClassificationDesc": "PO Box Zip",
            "uspsFacilityCode": "P",
            "uspsFacilityName": "Post Office",
            "uspsCityMailingInd": true,
            "uspsDeliveryCode": "Y",
            "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",
            "uspsCarrierRouteSortCode": "C",
            "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Do Not Apply-Merging Permitted",
            "uniqueZipNameInd": false,
            "uspsFinanceNumber": "484360",
            "stateCode": "TX",
            "stateName": "Texas",
            "stateFipsCode": "48",
            "stateAbbr": "Tex.",
            "countyFipsCode": "113",
            "uspsCountyName": "DALLAS",
            "titleCaseCountyName": "Dallas",
            "latitude": null,
            "longitude": null,
            "landAreaMi2": null,
            "waterAreaMi2": null,
            "landAreaKm2": null,
            "waterAreaKm2": null,
            "divisionCode": "7",
            "divisionName": "West South Central Division",
            "regionCode": "3",
            "regionName": "South Region",
            "msaCode": "19100",
            "msaName": "Dallas-Fort Worth-Arlington, TX Metro Area",
            "cityAliases": [
                {
                    "uspsCityKey": "W24197",
                    "uspsCityName": "IRVING",
                    "titleCaseCityName": "Irving",
                    "uspsCityAbbr": null,
                    "uspsCityMailingInd": true,
                    "uspsMainCityInd": true
                }
            ],
            "zipCodeStatistics": null
        }
    ]
}

Conclusion

In essence, the Zip Code API can serve as a valuable tool for businesses and organizations looking to gain insights into the geographic and demographic makeup of Metropolitan Statistical Areas for a wide range of applications.

Get US Population By Zip Code

Tue, 20 Feb 2024 19:07:33 GMT

Understanding ZCTAs

ZIP Code Tabulation Areas (ZCTAs) serve as a statistical approximation of U.S. Postal Service ZIP codes, providing a unique lens through which to analyze population data. Unlike traditional ZIP codes, ZCTAs are designed by the Census Bureau to represent geographical areas, making them a valuable tool for granular demographic insights.

The MetadAPI Population by Zip Code Dataset

The Census Bureau's ZCTAs population data is released every 10 years as a result of the decennial census. The U.S. Census Bureau conducts a census every 10 years to determine the number of people living in the United States. The census counts each resident of the country, where they live on April 1, every ten years ending in zero. This data is provided using the ZCTAs tabulation approximations to the USPS Zip Codes. Metadapi takes this information and produces a user friendly data model within the JSON response for the zip code information. The array zipCodeStatistics contains a model with the year, totalPopulation, malePopulation and femalePopulation for each zip code as highlighted on the example below.

{

  "year": 2020,

  "totalPopulation": 52943,

  "malePopulation": 25206,

  "femalePopulation": 27737

}

The full JSON model for Houston Texas zip code 77070 is presented below (where you can see the population for this zip code for the years 2000, 2010 and 2020).

{

    "links": {

        "self": "/zipc/v2/zipcodes/77070"

    },

    "meta": {

        "count": 1

    },

    "data": {

        "zipCode": "77070",

        "uspsMainCityKey": "W24130",

        "uspsMainCityName": "HOUSTON",

        "titleCaseCityName": "Houston",

        "zipClassificationCode": "N",

        "zipClassificationDesc": "Non-Unique Zip",

        "uspsFacilityCode": "P",

        "uspsFacilityName": "Post Office",

        "uspsCityMailingInd": true,

        "uspsDeliveryCode": "Y",

        "uspsDeliveryDesc": "Office Has City-Delivery Carrier Routes",

        "uspsCarrierRouteSortCode": "D",

        "uspsCarrierRouteRateSortDesc": "Carrier Route. Sortation/Rates. Do Not Apply-Merging Not Permitted",

        "uniqueZipNameInd": false,

        "uspsFinanceNumber": "484145",

        "stateCode": "TX",

        "stateName": "Texas",

        "stateFipsCode": "48",

        "stateAbbr": "Tex.",

        "countyFipsCode": "201",

        "uspsCountyName": "HARRIS",

        "titleCaseCountyName": "Harris",

        "latitude": 29.979456,

        "longitude": -95.57332,

        "landAreaMi2": 13.035,

        "waterAreaMi2": 0.128,

        "landAreaKm2": 33.76091,

        "waterAreaKm2": 0.330637,

        "divisionCode": "7",

        "divisionName": "West South Central Division",

        "regionCode": "3",

        "regionName": "South Region",

        "msaCode": "26420",

        "msaName": "Houston-The Woodlands-Sugar Land, TX Metro Area",

        "cityAliases": [

            {

                "uspsCityKey": "W24130",

                "uspsCityName": "HOUSTON",

                "titleCaseCityName": "Houston",

                "uspsCityAbbr": null,

                "uspsCityMailingInd": true,

                "uspsMainCityInd": true

            }

        ],

        "zipCodeStatistics": [

            {

                "year": 2000,

                "totalPopulation": 32385,

                "malePopulation": 15812,

                "femalePopulation": 16573

            },

            {

                "year": 2010,

                "totalPopulation": 46017,

                "malePopulation": 22355,

                "femalePopulation": 23662

            },

            {

                "year": 2020,

                "totalPopulation": 52943,

                "malePopulation": 25206,

                "femalePopulation": 27737

            }

        ]

    }

}

Population by Zip Code Use Cases

Analyzing census population by zip code can help with urban planning, resource allocation, and targeted community outreach. It's valuable for:

Resource Distribution: Efficiently allocating public services, such as schools, healthcare facilities, and emergency services based on population density in specific zip codes.
Business Planning: Understanding demographics helps businesses tailor their products/services and target marketing campaigns to specific regions.
Infrastructure Development: Planning and prioritizing infrastructure projects like roads, public transportation, and utilities based on population density and growth.
Policy Making: Informing policymakers about the unique needs of different communities, influencing decisions related to zoning, housing, and social services.
Healthcare Planning: Identifying areas with specific health needs, enabling better distribution of medical resources and public health interventions.
Education Planning: Tailoring educational programs and allocating resources based on the demographics and needs of different zip codes.
Emergency Response: Enhancing emergency response planning by understanding population distribution, ensuring effective evacuation plans, and allocating resources for disaster management.
Demographic Studies: Conducting detailed demographic studies to understand trends, social disparities, and changes over time.

By leveraging census population data at the zip code level, communities and organizations can make more informed decisions to address specific challenges and promote well-being.

Population by Zip Code Python Example

To bring theory into practice, let's take a look at the following Python code example. The Python code will send a list of zip codes to the List All Zip Codes endpoint to get the details for each of them. We are going to plot the population results of each zip code to compare them together.

The first part is to import the 2 libraries we'll be using on this example, "requests" to call API endpoints and matplotlib to create a chart with the results.

import requests
import matplotlib.pyplot as plt

Next we create a function to call the endpoint to get a list of zip codes 33009,33967,48201. (in the example below you need to replace the text with your API key from metadapi).

def fetch_data_from_api():

  vheaders = {"Ocp-Apim-Subscription-Key": ""}

  url = f"https://global.metadapi.com/zipc/v2/zipcodes?zipcode=33009,33967,48201"

  response = requests.get(url,headers=vheaders)  if response.status_code == 200: 

    return response.json()

  else:

    print(f"Failed to fetch data. Status code: {response.status_code}")

    return None

Next step we create a function that plots the population data for each zip code:

 def plot_population_data(data):

  for zipcodes in data['data']:

    years = []

    populations = []

    for zipstats in zipcodes['zipCodeStatistics']:

      years.append(zipstats['year'])

      populations.append(zipstats['totalPopulation'])

      plt.plot(years,populations, label = zipcodes['zipCode'])

plt.title("Population Over Years")

plt.xlabel("Year")

plt.ylabel("Total Population")

plt.legend()

plt.show()

To download the full source code visit the zip code github.

Running this code will give you the following graph showing the population for each of the zip codes provided:

Conclusion

The utilization of an API providing population data by zip code offers invaluable insights and benefits for various applications. This comprehensive data source empowers businesses, researchers, and policymakers to make informed decisions by understanding demographic trends and population dynamics at a localized level. Whether optimizing marketing strategies, enhancing urban planning, or tailoring public services, the precision and granularity of zip code-specific population information enable more accurate analyses and targeted initiatives.

Understanding FIPS Codes: A Key to Geographic Identification

Mon, 29 Jan 2024 19:45:46 GMT

What are FIPS Codes?

FIPS codes are a set of standardized codes developed by the National Institute of Standards and Technology (NIST) within the United States Department of Commerce. FIPS stands for Federal Information Processing Standards. These codes were introduced to facilitate uniform identification and classification of geographic entities such as counties and states. FIPS codes are primarily numerical, allowing for concise representation and easy integration into databases and information systems.

Types of FIPS Codes

There are two main types of FIPS codes – FIPS State Codes and FIPS County Codes:

FIPS State Codes: These are two-digit numerical codes assigned to each state and the District of Columbia in the United States. For instance, Alabama is represented by the FIPS State Code 01, while California is assigned the code 06.
FIPS County Codes: These are three-digit numerical codes assigned to each county within a state. FIPS County Codes are unique within a state, ensuring precise identification. For example, Los Angeles County in California is designated with the FIPS County Code 037.

Significance and Use of FIPS Codes

Government Administration: FIPS codes play a pivotal role in various government functions, such as census data collection, election administration, and federal funding distribution. When conducting a census or analyzing demographic trends, FIPS codes help organize and categorize data efficiently.

Emergency Services: In emergency management, FIPS codes are used to identify specific regions affected by natural disasters or emergencies. This aids in coordinating response efforts, allocating resources, and providing accurate information to the public.

Healthcare Systems: FIPS codes are integrated into healthcare information systems to facilitate regional health analysis, manage health resources, and study the prevalence of diseases across different geographic areas.

Business and Research: Various businesses and research institutions utilize FIPS codes to categorize and analyze data related to market research, economic trends, and regional development. This aids in decision-making processes and strategic planning.

Postal Services: FIPS codes are often utilized by postal services for efficient mail sorting and delivery. They contribute to the automation of address processing systems, minimizing errors and improving delivery accuracy. Conclusion: FIPS codes serve as an essential tool for standardizing geographic identification across various sectors. From government administration to emergency services, healthcare, business, and beyond, these codes streamline data management and analysis processes. As technology continues to advance, the utilization of FIPS codes is likely to evolve, further enhancing their role in geographic information systems and data-driven decision-making.

FIPS Codes on the US Zip Code API

The US Zip Code API by Metadapi enhances the zip code data with additional information that allows for a rich dictionary of elements to use in all kinds of solution developments. For each zip code we provide the "State" and "County" FIPS codes associated to it. As an example, for the Beverly Hills zip code 90210 the following state and county information is presented:

A simplified response to GET https://global.metadapi.com/zipc/v1/zipcodes/90210 :

"stateCode": "CA",

"stateName": "California",

"stateFipsCode": "06",

"stateAbbr": "Calif.",

"countyFipsCode": "037",

"uspsCountyName": "LOS ANGELES",

"titleCaseCountyName": "Los Angeles"

We do not treat the FIPS codes as purely numerical, the same way we don't treat zip codes as numbers, because these codes have leading zero's.

API Clients Review - 2024

Tue, 02 Jan 2024 22:25:00 GMT

Introduction

In the rapidly evolving landscape of software development, APIs (Application Programming Interfaces) have emerged as the cornerstone for seamless communication between diverse applications and services. As developers navigate through the intricate web of APIs, the importance of efficient API client tools becomes paramount. These tools not only simplify the interaction with APIs but also streamline the development process, making it more agile and productive.

In this comprehensive blog article, we delve into the realm of API client tools, exploring and evaluating a myriad of options available to developers. Whether you're a seasoned developer seeking to optimize workflows or a newcomer looking for the ideal tool to start your API journey, this review aims to unravel the best API client tools

What is an API Client?

An API client serves as a crucial intermediary that facilitates the interaction between software applications and APIs (Application Programming Interfaces). In essence, it acts as a bridge, enabling developers to send requests to APIs and receive responses, thereby accessing and utilizing the functionalities and data offered by these APIs.

Think of an API client as a tool or software component that simplifies the complexities of communication between different systems. It abstracts away the technical intricacies, providing developers with a user-friendly interface or programming library to make HTTP requests, handle authentication, format data, and interpret responses from APIs.

API Client	Description from Vendor	Features	Links
Postman	Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.	windows mac os linux cli web client vs code extension	Postman Home Page Postman Download Page Postman Documentation
Curl	Curl is used in command lines or scripts to transfer data. curl is also used in cars, television sets, routers, printers, audio equipment, mobile phones, tablets, medical devices, settop boxes, computer games, media players and is the Internet transfer engine for thousands of software applications in over twenty billion installations.	cli open source	Curl Home Page
Paw	The most advanced API tool for Mac. RapidAPI for Mac is a full-featured HTTP client that lets you test and describe the APIs you build or consume. It has a beautiful native macOS interface to compose requests, inspect server responses, generate client code and export API definitions.	mac os	Paw Home Page Paw Documentation
Thunder Client	Hand-crafted lightweight Rest Client for testing APIs. Supports collections, environments, git collaboration and local storage.	vs code extensioncli	Thunder Client Home Page
Hoppscotch	Hoppscotch is a lightweight, web-based API development suite. It was built from the ground up with ease of use and accessibility in mind providing all the functionality needed for API developers with minimalist, unobtrusive UI.	web clientopen source	Hoppscotch Client Hoppscotch Github Hoppscotch Documentation
Insomnia	Kong Insomnia is a collaborative open source API development platform that makes it easy to build high-quality APIs — without the bloat and clutter of other tools.	windows mac os linux	Insomnia Home Page Insomnia Plugins Kong Insomnia Documentation
Nightingale	A modern, resource-friendly REST client for Windows 10.	windows	Nightingale Home Page Nightingale Github
Advanced REST Client	Advanced REST client allows you to test your APIs. Easy and clean user interface helps you focus on your API and not tooling. Store your requests and projects on Google Drive and share it with your team.	windows mac os linux open source	Advanced REST Client Home Page Advanced REST Client Github Advanced REST Client Documentation
HTTPie	HTTPie is making APIs simple and intuitive for those building the tools of our time.	windows web client cli	HTTPie Home Page Web client app HTTPie Documentation
ApiScout	ApiScout is one and only Rest Client for macOS you will need while building, testing and describing your APIs. It's built for developers by developers.	mac os	ApiScout Home Page ApiScout Apple app store

Postman Review

https://www.postman.com/

Postman stands as a pivotal tool in the realm of API development, offering a comprehensive suite of features that streamline the process of designing, testing, and collaborating on APIs. Renowned for its user-friendly interface and robust functionalities, Postman has established itself as a go-to solution for developers seeking efficiency and flexibility in managing APIs.

Key Features of Postman:

Intuitive Interface: Postman's intuitive user interface simplifies the creation of HTTP requests, allowing users to effortlessly build and organize API requests. Its visually appealing workspace enables easy navigation and management of collections, requests, and environments.
Request Building and Testing: With Postman, developers can construct various types of requests (GET, POST, PUT, DELETE, etc.) and customize headers, parameters, authentication methods, and payloads. Its built-in testing framework facilitates the creation of automated tests, validating API responses for correctness and reliability.
Collection and Environment Management: Postman's collection feature allows users to organize API requests into folders, making it convenient to manage and share related requests as a cohesive unit. Environments enable the configuration of variables, easing the process of testing across different environments (e.g., development, staging, production).
Collaboration and Sharing: Collaboration is seamless in Postman, fostering teamwork through features like shared workspaces, comments, and team libraries. Developers can share collections, collaborate on API designs, and synchronize changes, promoting efficient teamwork and knowledge sharing.
Mock Servers and Documentation: Postman facilitates the creation of mock servers from API definitions, enabling developers to simulate API endpoints for testing purposes even before the actual implementation. Additionally, it offers tools to generate comprehensive API documentation automatically, simplifying the process of documenting APIs for internal or external use.
Integration and Automation: Postman seamlessly integrates with various third-party tools and services, allowing for enhanced automation and workflow customization. Integration with CI/CD pipelines, monitoring tools, and version control systems streamlines the development lifecycle.
Extensive Community Support: The Postman community is vibrant and supportive, offering a plethora of resources, including tutorials, templates, and forums. Users can tap into this wealth of knowledge to learn, troubleshoot, and explore best practices in API development.

Postman Cons:

Software is complex to use for first time users. Because of its rich functionality and plethora of options, the software requires a level of training that will allow users to proper leverage the solution.
API Documentation could use some improvements. The documentation capabilities feels a bit cumbersome.
Test cases with external dependencies are hard to manage. Connectivity to databases, or more programmatic test case writing is not easy to do.

Overall, Postman's robust feature set, combined with its rich interface and collaborative capabilities, makes it a great tool for developers, QA engineers, and API enthusiasts alike. Its ability to simplify API testing, documentation, and collaboration contributes significantly to optimizing the API development process, making it a staple in modern software development workflows.

Curl Review

https://curl.se/

Despite its seemingly simple command-line interface, stands as a powerful and versatile API client tool widely favored among developers and system administrators alike. Renowned for its flexibility, efficiency, and portability, Curl excels in performing HTTP requests and is celebrated for its wide-ranging capabilities.

Key Features of Curl:

Command-Line Interface: Curl's command-line interface (CLI) allows for quick and straightforward execution of HTTP requests directly from the terminal, providing developers with a lightweight and portable solution for API interaction. Its simplicity enables users to craft requests efficiently using various options and flags.
Wide Protocol Support: Curl supports a multitude of protocols beyond HTTP and HTTPS, including FTP, FTPS, SCP, SFTP, LDAP, and many others. This broad protocol support makes it a versatile tool capable of handling diverse data transfer requirements (outside of just API requests).
Customization and Flexibility: Users can tailor requests extensively by specifying headers, HTTP methods, request bodies, authentication methods, and more, offering a high degree of flexibility in crafting and fine-tuning requests according to specific needs.
Output Formatting and Data Handling: Curl offers options for handling response data, such as displaying headers only, saving output to files, or formatting responses in various ways. This flexibility in managing output facilitates easy parsing and manipulation of API responses.
Proxy Support and Network Operations: It provides support for proxies, allowing users to route requests through different proxy servers.
Cross-Platform Compatibility: Curl is available across multiple platforms, including Windows, macOS, and various Unix-like systems, ensuring consistent functionality and ease of use across different operating environments.
Scripting and Automation: Its command-line nature makes Curl highly conducive to scripting and automation. Developers can incorporate Curl commands into scripts and workflows, enabling automated testing, monitoring, and integration within larger systems or pipelines.
Open-Source and Community Support: Being an open-source tool, Curl enjoys extensive community support. Users can benefit from a wealth of documentation, forums, and resources contributed by the community, fostering learning and troubleshooting.

Cons:

Not easy for beginners, since there is no UI (interface) it’s hard to get a guided approach to building requests.
Creating “complex” api requests is hard. Simple API requests are very straightforward on the Curl syntax, but as that simplicity goes away and more complex requests need to be built, the syntax on Curl could get quite cumbersome.

Curl's command-line interface, coupled with its extensive feature set and support for multiple protocols, makes it a preferred choice for scenarios where simplicity, portability, and flexibility are paramount. While its command-line nature might initially present a learning curve for beginners, its versatility and capabilities make Curl an indispensable tool in the arsenal of developers, system administrators, and anyone handling HTTP requests and data transfers.

Paw Review

https://paw.cloud/

This macOS-exclusive application provides a comprehensive environment for designing, testing, and debugging APIs, making it a go-to choice for professionals seeking a powerful and intuitive API development experience. It seems the product is being re-branded as RapidAPI for Mac.

Key Features of Paw:

Intuitive User Interface: Paw boasts an intuitive and visually appealing interface that simplifies the creation and organization of API requests. Its user-centric design facilitates seamless navigation and enhances the overall user experience.
Dynamic Request Building: The tool allows for the creation of complex API requests effortlessly, supporting various HTTP methods, custom headers, query parameters, authentication mechanisms (including OAuth), and request body formats. Users can generate requests using a multitude of built-in templates or create their own, fostering flexibility in API testing and exploration.
Environment and Variable Management: Paw offers robust support for managing environments, enabling users to define and switch between different sets of variables (e.g., URLs, API keys, tokens) for testing across various environments. This feature streamlines the testing process in different development stages.
Response Visualization and Validation: It provides a visual preview of API responses, aiding in understanding and validating the data returned by the API. Paw supports various response viewers for JSON, XML, HTML, and other formats, enhancing readability and analysis of API responses.
Code Generation and Integration: One of Paw's standout features is its ability to generate code snippets in multiple programming languages directly from API requests. This feature facilitates seamless integration with the user's codebase and accelerates the development process.
Extensions and Customization: Paw supports extensions that extend its functionality, allowing users to tailor the tool to their specific needs. Users can create their extensions or leverage existing ones from the Paw Extension Registry to enhance the tool's capabilities.
Collaboration and Teamwork: With built-in collaboration features, Paw facilitates team-based API development. Users can share workspaces, collaborate on API designs, and synchronize changes, fostering efficient teamwork and knowledge sharing.
Comprehensive Documentation: Paw simplifies the process of documenting APIs by providing tools to generate comprehensive documentation automatically. This documentation can be shared with team members or external stakeholders.
Easy migration tools. Paw provides extensions that allow easy migration from other API Clients.

Overall, Paw's is a good client for Mac users. It provides a clean interface with a lot of functionality.

Thunder Client Review

https://www.thunderclient.com/

Thunder Client is a lightweight and versatile API client extension specifically designed for Visual Studio Code. This tool aims to simplify API testing and development within the familiar environment of Visual Studio Code, offering a range of features tailored to enhance productivity and streamline the API testing process.

Key Features of Thunder Client:

Seamless Integration with Visual Studio Code: Thunder Client seamlessly integrates into Visual Studio Code, allowing developers to work within their preferred coding environment. This integration ensures familiarity and ease of use for developers already accustomed to Visual Studio Code.
Leverage Visual Studio Code Interface: Thunder Client leverages the visual studio code user interface and simplifies the creation and execution of API requests by enabling an easy to use API request interface. It provides a visually appealing workspace for managing requests, collections, environments, and response data, ensuring easy navigation and organization.
Multiple Request Types and Customization: It supports various HTTP request types (GET, POST, PUT, DELETE, etc.) and allows customization of request headers, parameters, authentication methods, and body content, catering to diverse API testing requirements.
Environment Management: Thunder Client facilitates the creation and management of environments, enabling users to define variables (e.g., base URLs, authentication tokens) specific to different testing environments. This feature aids in seamless testing across multiple setups.
Response Handling and Visualization: The tool provides a clear visualization of API responses, aiding in understanding and validating the data returned by the API. Thunder Client supports response viewers for various formats, enhancing readability and analysis of API responses.
Collection Organization: Developers can organize API requests into collections, allowing for better management and sharing of related requests as a cohesive unit. This feature helps maintain a structured workflow and simplifies collaboration among team members.
Lightweight and Fast: Thunder Client is designed to be lightweight and fast, ensuring quick response times and smooth execution of API requests, thereby optimizing the testing and development process.
Extension Ecosystem: As an extension for Visual Studio Code, Thunder Client benefits from the extensive extension ecosystem of VS Code. Users can further enhance its capabilities through various available extensions, customizations, and integrations.

Thunder Client's focus on simplicity, integration with Visual Studio Code, and its array of essential features for API testing and development make it an attractive choice for developers seeking a lightweight yet powerful tool within their familiar coding environment. Its intuitive interface, coupled with its ability to handle diverse API testing scenarios, contributes to a smoother and more efficient API development workflow within Visual Studio Code.

Cons:

Requires use of visual studio code. If not a VS developer, not much sense using it.

Hoppscotch

https://hoppscotch.io/

Hoppscotch API Request Builder, is anAPI client tool available as an open source web-based application and browser extension. You can leverage hopscotch directly on their web interface or download the source application from Github.

Key Features of Hoppscotch API Request Builder:

Intuitive User Interface: Hoppscotch boasts a simple interface with a very clean design
Diverse HTTP Request Support: The tool supports various HTTP request methods (GET, POST, PUT, DELETE, and support for GraphQL.) and allows customization of headers, parameters, authentication methods, and request bodies, catering to diverse API testing and development needs.
Collections and Workspaces: Hoppscotch facilitates the organization of API requests into collections and workspaces, allowing for better management, grouping of related requests, and sharing of collections among team members.
Real-time Response Visualization: It provides a real-time preview of API responses, aiding in understanding and validating the data returned by the API. Users can view and analyze responses in different formats, enhancing readability and analysis of API data.
Environment Variables and Global Values: Hoppscotch supports the use of environment variables and global values, enabling users to define and switch between different sets of variables for testing across multiple environments, improving flexibility and efficiency.
Import and Export Functionality: The tool offers capabilities to import and export API requests and collections in various formats, allowing for easy sharing, backup, and migration of data across different instances.
Collaboration Features: Hoppscotch provides collaboration features, including sharing and syncing workspaces, fostering teamwork, and enabling multiple users to collaborate on API development projects.
Open-Source and Extensibility: Being open-source, Hoppscotch encourages community contributions and supports extensibility, allowing users to enhance its functionalities through customizations and extensions.

Cons:

No desktop app, for those that like client applications, the only way to use Hoppscotch is via web browser.

Insomnia

https://insomnia.rest/

Insomnia, a popular API client tool, has earned acclaim for its sleek interface, comprehensive feature set, and focus on simplifying the API testing and development process. Available as a standalone desktop application for various operating systems, Insomnia has become a go-to choice for developers seeking an intuitive and powerful environment for designing, testing, and debugging APIs.

Key Features of Insomnia:

Clean and Intuitive Interface: Insomnia offers a clean, user-friendly interface that facilitates easy navigation and efficient management of API requests, environments, workspaces, and collections, ensuring a smooth workflow.
Versatile Request Building: The tool supports a wide range of HTTP request methods (GET, POST, PUT, DELETE, etc.) and allows customization of headers, query parameters, authentication mechanisms (including OAuth), and request payloads, enabling flexible and comprehensive request creation.
Environments and Variables: Insomnia supports the creation and management of environments, allowing users to define variables specific to different testing environments. This feature simplifies testing across multiple setups and enhances productivity.
Request Chaining and Templating: Users can create request chains, enabling the extraction of values from one request to be used in subsequent requests, thereby facilitating complex API workflows. Insomnia also supports request templating for reusability and efficiency.
Code Generation and Exporting: Insomnia provides the ability to generate code snippets in various programming languages directly from API requests, streamlining integration with the user's codebase. It also supports exporting requests and collections in different formats for sharing and documentation purposes.
Real-time Response Visualization: The tool offers real-time previews of API responses, allowing users to visualize and validate data returned by the API in different formats, aiding in debugging and analysis.
Collaboration and Teamwork: Insomnia supports collaboration features, such as sharing workspaces, enabling multiple team members to collaborate on API projects, fostering efficient teamwork and knowledge sharing.
Plugins and Extensibility: Insomnia's extensible nature allows users to extend its functionalities through plugins and integrations, enabling customization and enhancing its capabilities based on specific requirements. Plugin Hub - Insomnia Insomnia has an extensive list of plugins and allow users to build their own.

Cons:

Not a lot of available documentation.
Small user community.

Nightingale

https://nightingale.rest/

Nightingale, an API client for Microsoft windows. Stands out for its simplicity. With a clean interface, it allowed effortless navigation and organization of API requests. Supporting various HTTP methods, it offered customization options for headers, authentication, and request bodies. Nightingale enabled real-time response visualization, environment variable usage, and code generation. Collaborative features are in progress.

Cons:

Project has not been updated in a while.
Lack of proper software support.

Advanced REST Client

https://www.advancedrestclient.com/

A Mulesoft tool, advanced rest client provides a basic user interface to run API requests. It provides easy integration to Mulesoft’s Anypoint Exchange.

Advanced rest client is also able to read any API specification for easy-to-read documentation.

HTTPie

https://httpie.io/

HTTPie is a user-friendly, command-line HTTP client that simplifies interactions with APIs. Renowned for its simplicity and ease of use, it offers a streamlined experience for making HTTP requests and handling API interactions. Client desktop applications are currently (as of January 2024) in Beta.

Key Features of HTTPie:

Simple Command-Line Interface: HTTPie operates via a straightforward command-line interface (CLI), making it easy for users to compose and execute HTTP requests without complex configurations or setups.
Intuitive Syntax and Request Building: It utilizes a simple and intuitive syntax for constructing HTTP requests, supporting various methods (GET, POST, PUT, DELETE, etc.), custom headers, query parameters, request bodies, and authentication methods.
Output Customization and Formatting: HTTPie allows users to customize and format the output of API responses, providing options to display headers only, pretty-print JSON, or format responses according to specific preferences.
Session and Authentication Management: Users can manage sessions and persist authentication credentials across requests, streamlining the testing process by avoiding repeated authentication steps.
Plugin System and Extensions: HTTPie's plugin system enables users to extend its functionalities with custom scripts or third-party plugins, enhancing its capabilities based on specific needs or requirements.
JSON Support and Data Handling: It offers native support for JSON data, simplifying the handling and manipulation of JSON payloads in requests and responses.
HTTPS, Proxies, and Security: HTTPie supports HTTPS and allows users to configure proxies, ensuring secure communication and enabling requests to traverse different network setups.
Cross-Platform Compatibility: HTTPie is compatible with various operating systems, including Windows, macOS, and Linux, ensuring consistent functionality across different environments.

ApiScout

https://theapiscout.com/

Mac OS REST API client. API Scout is gaining attention for its user-friendly interface and a range of functionalities aimed at simplifying API-related tasks.

Key Features of API Scout:

Clean and Intuitive Interface: API Scout featured a clean and user-friendly interface, ensuring ease of navigation and management of API requests, endpoints, and collections.
Request Building and Customization: The tool allowed for the creation of various HTTP requests (GET, POST, PUT, DELETE, etc.) and enabled customization of headers, query parameters, authentication methods, and request bodies, ensuring flexibility in crafting requests.
Collections and Organization: Users could organize API requests into collections, aiding in better management, grouping of related requests, and facilitating sharing of collections among team members.
Response Visualization: API Scout provided real-time previews of API responses in different formats, aiding in validating data returned by the API and simplifying the debugging process.
Environment Variables: It supported the use of environment variables, allowing users to define and switch between different sets of variables for testing across multiple environments, enhancing flexibility in testing.
Exporting and Sharing: The tool offered capabilities to export requests and collections in various formats, enabling easy sharing and collaboration among team members.
Security and HTTPS Support: API Scout ensured secure communication by supporting HTTPS, allowing for secure interactions between the client and the API server.
Collaboration and Teamwork: Team collaboration, allows multiple users to work together on API projects.

Conclusion

In conclusion, the diverse landscape of API clients presents a myriad of options catering to different needs and preferences, offering developers an array of tools to streamline their workflow and enhance application integration. Whether it's about performance, simplicity, or specific functionalities, the reviewed API clients showcased a spectrum of features, empowering users to make informed choices based on their project requirements. Ultimately, navigating through these clients demands a careful consideration of factors such as ease of use, compatibility, and scalability. With the evolving nature of technology, staying updated on the latest advancements and innovations in API clients remains paramount. As the digital ecosystem continues to expand, these versatile tools will undoubtedly play an increasingly pivotal role in shaping the efficiency and success of software development endeavors.

Top Photo by Douglas Lopes on Unsplash

County Lookup by Zip Code

Wed, 12 Jul 2023 21:51:00 GMT

In today's fast-paced and interconnected world, businesses face the constant challenge of finding innovative ways to gain a competitive edge. One often overlooked but incredibly valuable tool is the ability to perform a county lookup by zip code. This seemingly simple feature has the potential to unlock a wealth of information and provide significant business benefits.

Understanding the demographics, market potential, and regional dynamics of a specific county is crucial for making informed business decisions. By harnessing the power of county lookup by zip code, businesses can gain a deeper understanding of their target audience, optimize their marketing efforts, and identify untapped opportunities.

What is a county?

A county is a geographic and administrative division within a state or country. It is typically smaller than a state or province but larger than a city or town. Counties serve as a way to organize and govern specific regions, ensuring the efficient delivery of public services and facilitating local administration.

The specific responsibilities and powers of counties can vary between different countries and even within different states or provinces. Generally, counties are responsible for a range of functions, including maintaining public records, overseeing elections, providing law enforcement and public safety services, managing public health services, administering courts, maintaining roads and infrastructure, and collecting property taxes.

Business Benefits of County Lookup by Zip Code

Targeted Marketing: Businesses can use county-level data to understand their customer base, target their marketing efforts, and tailor their advertising campaigns. By knowing the counties where their customers are located, businesses can create more effective and personalized marketing strategies.
Sales Analysis: Businesses can use county-level data to analyze their sales performance in different regions. By looking at sales data broken down by county, businesses can identify which areas are driving the most sales and which areas might need more attention.
Delivery and Logistics: Businesses that offer delivery or logistics services can use county-level data to optimize their operations. By knowing which counties they are delivering to, businesses can plan their routes more efficiently and ensure that their deliveries are reaching their intended destinations.
Customer Service: Having county-level data can also help businesses provide better customer service. By knowing where their customers are located, businesses can provide more personalized support, such as local recommendations or information about nearby events.
Regulatory Compliance: Depending on the industry, businesses may need to comply with various county-level regulations or restrictions. By having a county lookup by zip code, businesses can easily determine which regulations apply to their operations in a given area.

How to Use the Zip Code API to get the county of the zip code

It's really easy to get the county information with the Zip Code API. It provides the county information for all zip codes on the JSON response. Using your favorite API tool open a request for any zip code, for example here we get the Beverly Hills Zip Code 90210:

GET https://global.metadapi.com/zipc/v1/zipcodes/90210

The response will have the county FIPS code, County name and county Title Case name included in the response.

        "countyFipsCode": "037",
        "uspsCountyName": "LOS ANGELES",
        "titleCaseCountyName": "Los Angeles",

Counties play a vital role in regional governance, helping to facilitate local decision-making, provide essential services, and ensure the effective administration of a specific geographical area. Using the county information provided by our Zip Code API you can always have this information available for any of your business use cases.

What is a Zip Code?

Sun, 29 Jan 2023 16:08:06 GMT

A ZIP code is a postal code used by the United States Postal Service (USPS) in a system it introduced in 1963. The term ZIP, an acronym for Zone Improvement Plan, was chosen to suggest that the mail travels more efficiently, and therefore more quickly (zipping along), when senders use the code in the postal address.

The basic format of a ZIP code is a five-digit number representing a specific area or delivery route. In 1983, an extended ZIP+4 code was introduced; it includes the five digits of the ZIP code, a hyphen, and four more digits that determine a more specific location within the ZIP code.

The USPS uses the ZIP code system to efficiently and accurately deliver mail. However, the use of ZIP codes extends beyond mail delivery. Many organizations, businesses, and even individuals use ZIP codes to gather and analyze data about a specific geographic area. This data can be used for a wide range of purposes, such as targeted marketing, demographic analysis, and even crime mapping.

Additionally, many online services and websites use ZIP codes to provide personalized information and recommendations to users. For example, weather forecasts, news, and even dating apps may use a user's ZIP code to provide localized information.

While ZIP codes are assigned based on geographical areas, they are not the same thing. ZIP codes are used by the USPS to deliver mail, while geographical areas are used to define and study different regions for a wide range of purposes. A ZIP code can include multiple geographical areas, and a geographical area can include multiple ZIP codes. For example, a city like New York can be split into multiple zip codes, and a particular zip code can include multiple neighborhoods. This is the reason why zip codes and geographical areas may overlap, but they are not the same thing.

In terms of maintenance, the USPS is responsible for maintaining and updating the ZIP code system. This includes assigning new codes as needed, changing existing codes due to population shifts, and making sure that all addresses are accurate and up-to-date.

Overall, the ZIP code system is an important tool that plays a crucial role in mail delivery and a wide range of other uses in the United States. It helps organizations and individuals to analyze and understand the geographic areas they operate in, and also offers a convenient way to find information and services tailored to specific locations.

The Zip Code API is a fast, secure and comprehensive zip code service

REST API -- JSON RESPONSE -- SSL -- EASY TO USE

Try Today!

Dynamically Invoking REST API with Data Factory

Thu, 19 Jan 2023 23:56:45 GMT

In this entry we are looking at dynamically creating a REST API call based on the source data within a Data Factory pipeline. We’ll use the Zip Code API from Metadapi to showcase how this is done. Please note that this pattern can be used to create a data pipeline between a file and a file, file and any database table, Data Lake and SQL Server, Data Lake and Azure Synapse, etc. the pattern just needs to replace the source and/or target endpoints and you can have many different integrations on your pipeline.

Here's the pattern:

Prerequisites

Knowledge of data pipeline concepts, data factory and SQL server.
Azure SQL Server DB and Azure Data Factory resources running on your Azure account.
The US Zip Code API subscription key.

Setup

We have 2 tables that will be used on this tutorial, the first one called dbo.sourceCRM that contains the customerId and zipCode from a sample leads database. Our goal is to take this basic zip code information and append to it additional data that will be used by our analytical platforms and load it into table dbo.targetCRM with the following additional columns (find the DDL used and table load script in our github repository):

stateCode
stateName
titleCaseCountyName
titleCaseCityName
latitude
longitude
msaCode
msaName

If you would like to see all the data points available on the US Zip Code API please look at the JSON schema definition.

Build Azure Data Factory Pipeline

From your Azure Data Factory Studio create a new pipeline. This pipeline will include the required data flow to implement the ETL pattern. In this example we'll name the pipeline "CRMLeads"

From the Activities menu, let's add a new DataFlow activity.

When you create a new Data Flow you must go to the settings and create a new data flow (again because this is a net new data flow, and we are not re-using an existing one).

Our data flow will include 6 tasks or steps for the ETL pattern to complete, at the end of the build the flow should look like this:

Step 1. Add Source

The source table that resides on an Azure SQL Server database needs to be added to the flow, click on the "Add Source" drop down and select "Add Source"

On the source settings tab, click on create new dataset (this is needed to configure the SQL Server database and table that will be used on this pipeline)

From here you're able to select Azure SQL Database from the list of options and click continue.

We should be able to create the linked service (for our database). Click on "New" to setup the linked service. Here we'll input the database connection information. Since our DB is running on the same account as the data factory service, we'll select the database and provide the connection information. (this configuration will be different on each organization).

We need to input all the database information from our Azure subscription. Fill in your database connection details.

We should be able to now select the source table we'll use for this pipeline. Look for table dbo.sourceCRM (created on the setup step of this tutorial).

Once selected we can click Ok.

The source transformation is now complete.

Step 2. Add derived column transformation

The next transformation we add on the data flow is a derived column transformation. We need to take the zip code string from the data source and "build" a REST API request for each row (this transformation doesn't make the API call, but helps on building the "endpoint" needed to get the Zip Code details).

The endpoint we'll use from the API service is https://global.metadapi.com/zipc/v1/zipcodes/{zipcode}.

The last part of the endpoint needs to be replaced with the actual zip code from the source database, to do this we'll create a new column on our data flow called zipCodeDetailsRequest that has the following expression:

[code:c#]'/zipcodes/' + zipCode[/code]

We will use this column in the next transformation.

Step 3. Add external call transformation

The external call transformation allows to call an external service (i.e. a REST API) and capture the response to use on the pipeline.

When we add the external call, select REST for the Inline dataset type. Then we need to configure the "linked service" that will be used for the API call (this configures the connection information to the API service).

We name the linked service as "ZipCodeAPI" and set the base URL as :

[code:plain]https://global.metadapi.com/zipc/v1[/code]

(as a best practice add this API at the root level so you can re-use the same linked service on all the endpoints available from the service).

The US Zip Code API uses an API key to authenticate valid requests, this key must be passed on the HEADER of the API request. To do this we (1) set on the ADF linked service "Authentication type" to "Anonymous". (2) Enable server certificate validation (for added security), and we add auth headers configured as follows:

(3) Name: Ocp-Apim-Subscription-Key
(4) Value: Your API Key

Click Apply to save the configuration of the REST API linked service

On the external call transformation settings we set the "row relative url" to the input: zipCodeDetailsRequest. This allows to create the dynamic calls for the zip code API using each zip code value from the source table.

You can check the Skip writing relative url (used to write the url to the body of the request, this is not needed) and Cache for repeat requests (if you have multiple rows with the same Zip Code, ADF can cache those results to speed up the process).

On the Output tab we need to configure how ADF will process the JSON response (it needs ADF syntax). Under the body definition, the type box must have the following ADF syntax definition of the JSON response:

We can uncheck the Header and Status (we don't need them on this example). In summary what this does is creates a new "column" called "body" that has the JSON response from the API call.

Download the updated ADF syntax definition of the Metadapi Zip Code API here.

Step 4. Add derived column 2 transformation

We don't want to pass the body object created in the step above to the database, we only need to extract 8 "selected" fields from the response. To do this we use again the derived column transformation, we are going to create the 8 columns we need, and parse the values out from the API response object.

We create those columns on the Derived Columns settings (we use the same name as the JSON response, this is the same name used by the target database table). For each of the columns, on the expression box you can either build the expression by using the expression builder (this let's you select the fields you need) or directly type the expression value (Example: body.data.msaCode

The only exception to this is the expression for latitude and longitude, since the target table has these columns as numbers with decimals, we take the latitude and longitude "strings" and convert them to double using the expression toDouble(). (toDouble(body.data.latitude))

Your final configuration should look like this:

Step 5. Add select transformation

We now use the select transformation to "remove" unwanted columns from what we send to the target. We do this because as of this writing, we can't send the complex object contained in the "body" column to a target SQL server table.

So we find "body" from the list of columns and we click on the trash icon so it's not passed to the next step.

Step 6. Add sink (target)

The last step in the data flow is the sink (or target table). We add a sink object:

We will leverage the same linked service that was created on step 1 (our source table and target table reside on the same database). If you have your target table in a different database you'll have to create a new linked service for the target database.

We will use the "Auto Mapping" option in the "Mapping" tab of the sink configuration (ADF will map the columns based on the column name, in this tutorial they are all consistent). We are now ready to run the pipeline.

Run pipeline

To run the pipeline select the Pipeline tab CRMLeads and from the options menu select Add trigger/Trigger now to manually run the pipeline.

You can then go to the "Monitor" tab to view the process overview. Once the status is "Succeeded" we are done with the execution of the pipeline.

A quick check into our target table using any SQL tool shows the results of the pipeline execution:

[code:sql]select * from dbo.targetCRM[/code]

We have successfully created a Data Factory pipeline that calls a dynamically generated REST API endpoint to enhance the data from our CRM system.

Additional resources:

Python Code to Enhance Zip Codes

Mon, 21 Nov 2022 22:24:00 GMT

This example walks us trough a very simple Python Code that opens a file with a list of zip codes and creates a new CSV file that includes additional details related to the zip code. You can find this example in the Zip Code github repository.

Let's dive right into it.

Pattern:

The first thing we'll do is make sure we have an API Key for using the Zip Code API. You can get a free trial here.

Code Review

import requests
import csv

We need to use the Python libraries "requests" (to manage API calls) and "csv" to easily manipulate csv files.

vheaders = {"Ocp-Apim-Subscription-Key": ""}

In this section you need to replace the value between the quotes to your API Key. This information is passed in the header section of the REST API call.

with open(r'sample-zips.txt', 'r') as fp:
with open('zip-enhanced.csv', 'w',newline='') as f:
writer = csv.writer(f)

Using the "with" command we'll open the sample-zips.txt file for "read" and we'll open the file zip-enhanced.csv file for write (note: if the file zip-enhanced.csv exists already, it will be replaced when the code executes).

for line in fp:
vzipcode = line.strip()
url = f"https://global.metadapi.com/zipc/v1/zipcodes/{vzipcode}"
response = requests.get(url,headers=vheaders).json()
csvline = [vzipcode,response["data"]["stateCode"],response["data"]["stateName"],
response["data"]["titleCaseCountyName"],response["data"]["latitude"],response["data"]["longitude"] ]
writer.writerow(csvline)

In this section, we have a loop for each line of the sample-zips.txt, the first step is to assign to the variable vzipcode the current line (minus any special characters for end of line).
We then build the endpoint to get details of the zip code (the string value of the endpoint in the variable url).
Next we call the API and assign it to object "response", it's a GET request to the endpoint defined in "url" and we pass the zip code api key in the header.
We now create a csv line (i.e. comma separated attributes) and we look for specific attributes of the zip code that we need (the state code, the state name, the county of the zip code, the latitude and longitude). You can see the full schema of the Zip Code response here, there are many other attributes to serve a multitude of needs.

Get the Zip Code API and start building an awesome solution!

Try it Now!

Postman Tutorial

Sat, 23 Apr 2022 21:56:06 GMT

Introduction to Postman

The following is a common scenario, there is a new requirement in your application (or data pipeline, website, report, etc.) and you realize that you can save hundreds of hours in development if you leverage and existing service that makes available the logic/data/service via an existing API’s for anyone to consume. Now you have to integrate this API into your development environment and get the results you are looking for, but you have yet to understand how the API works. Yes, you’ve seen the API documentation, you know how to call API’s in your development language of choice, but you are looking to quickly see the API in action, make sure the service is accessible, run an API request, see the data, you get the idea. You want to quickly test the API without having to write code in you application and make sure everything works as expected. One way to do this is to leverage Postman.

Postman describes itself as a platform to build and use API’s, and we’ll use it today to quickly test an API.

We’ll use this sample use case as an example: Our application order page needs to check that the zip code provided by the customer is a valid US and not a PO Box because you can’t deliver your product to PO Boxes. You find Metadapi’s Zip Code API with all of the US zip codes and realize that you can get this requirement done very quickly by leveraging the data provided by this API.

Let's get started !

Installing Postman

The first thing you need to do is download Postman (https://www.postman.com/downloads/) . You also have the option to use the browser version of Postman (if you don’t want to download any software). All your data can synch between your local installation and the Postman service so it makes portability really easy.

Navigating the Interface

When you open Postman the first thing you want to do to get running quickly is to select the Workspaces tab

Workspaces are a way to organize your work, the work of teams the organization’s work within Postman. If you are working in a team, and several people need access to API requests, then a team workspace is needed so you can share the work with other members of your group.

To get started we'll be using a personal workspace. We we need to create a Collection. A collection is a way to save different API requests. Collections can be organized in many different ways, by project, by API, by department, etc. For our use case we’ll create a Collection called “Zip Code API”.

Click the plus sign in the collections tab.

The new collection details appear:

Type the name of the collection as Zip Code API.

We are going to put all the different API requests to the Zip Code API in this collection. Since we are only using API’s from Metadapi in this example, to save time we’ll add the API Key to the collection so that every request we put on this collection automatically adds the API key. All your Metadapi API keys are located in the My API’s page in your account. We get the value of the API key here to add it to the postman authorization.

In the Zip Code collection click the authorization tab and select API Key

The following information is needed to setup the API Key:

The name of the key: Ocp-Apim-Subscription-Key
The value of the key:
The location of the key: Header.

Click the “Save” button.

Any API we place in this collection will include this heading.

Next, we’ll add a request to the collection.

This will open the add request window.

We’ll add the following information:

We’ll name the request: Get Valid Zip Code Not a PO Box
We select a GET operation.
We’ll use the Zip Code Details endpoint like this:

https://global.metadapi.com/zipc/v1/zipcodes/90210

Click the send button to execute !

We have executed our first API in Postman !

We can now explore the data returned by the API to get a better understanding of the code we need to write.

The endpoint documentation shows us that the element zipClassificationCode has a specific value when a zip code is a PO Box (Value of P)

When exploring the result we see in the payload the code that is available on this specific zip code.

Our testing team let’s us know that zip code 90009 in California is a PO Box. We have 2 choices now with Postman:

We just replace the zip code on the existing call or
We create a new GET request on the folder and give it a different name.

Both options are valid, after all we are trying to test the data, our preference is to always save different calls (even if they use the same end point) on different requests because then we can easily view and replicate different test cases as they come along. (those tests can also be automated).

So we now create a new GET request called Get Valid Zip Code PO Box

And we see the PO Box classification code in the results.

We do the same process to create 2 more scenarios, a valid syntax but invalid zip code (i.e. 11111) and invalid syntax zip code (i.e. house).

After exploring the result of the valid syntax but invalid zip code we see there is no data object and the count on the meta object is set to 0.

Next we create a new request called Invalid syntax, and instead of using a zip code value, we pass a random word. In this example the word "house".

The invalid syntax returns something completely different:

This time the API fails with a 400 Bad Request and the error message specifies that the syntax is incorrect. So now we have created 4 different types of calls, we understand how the data is return and what’s happens on each different case when dealing with the Zip Code API. We can now take this information and create the necessary code (you can use any programming language to call this API).

Our Postman Collection should look like this:

As you can see, using Postman as a client tool to run API calls is really easy. But the tool itself has a lot of functionality that is not covered in this tutorial, we just scratched the surface when it comes to postman.

Next Steps

Check the Postman Getting started guide. This is an excellent easy to read tutorial on all things Postman.
If you like video tutorials, the course "Postman Beginner's Course - API Testing" is a very complete tutorial on how to use postman. It's 2 hours long but it's easy to follow along.

Get the Zip Code API and start building an awesome solution!

Try it Now!