# VA.gov Self-Service (eBenefits) Reference Guide (`alizarin_refrigerator-owner/ebenefits-va-gov-api`) Actor

Reference guide to VA.gov self-service topics: claim types, letters, direct deposit, dependents, sample facility listings, ID cards, travel pay, and appointments. Returns built-in reference data with official links; it does not sign in to VA.gov or read anyone's records.

- **URL**: https://apify.com/alizarin_refrigerator-owner/ebenefits-va-gov-api.md
- **Developed by:** [The Howlers](https://apify.com/alizarin_refrigerator-owner) (community)
- **Categories:** Agents, Automation, Integrations
- **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.01 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## VA.gov Self-Service (eBenefits) Reference Guide

Reference guide to VA.gov self-service topics: claim types, letters, direct deposit, dependents, sample facility listings, ID cards, travel pay, and appointments. Returns built-in reference data with official links; it does not sign in to VA.gov or read anyone's records.

**What this actor returns.** Built-in reference data that ships with the actor: program descriptions, eligibility summaries, phone numbers, and official links. It is a curated snapshot that is not updated automatically. It does not connect to VA.gov or eBenefits (it never signs in and cannot see anyone's claims, letters, or records). Demo Mode on returns a labeled sample. Demo Mode off returns the same built-in reference data, plus a pointer to the official source. Every output row carries `dataSource: "built-in reference data"` and `isLiveData: false`. Before relying on any detail, confirm it with the official source: VA.gov or 1-800-827-1000.

***

### Quick Start

#### Test with Demo Mode (free, no API key needed)

```json
{
  "demoMode": true
}
```

#### Run a reference lookup (same built-in data, with the official-source pointer)

```json
{
  "demoMode": false,
  "task": "get_claim_types",
  "radius": 50
}
```

***

### Input Parameters

| Parameter | Type | Default | Required | Description |
|-----------|------|---------|----------|-------------|
| `task` | string | `"get_claim_types"` | Yes\* | The operation to perform on the eBenefits/VA.gov API |
| `facilityType` | string | - | No | Type of VA facility to search for |
| `state` | string | - | No | State for facility search (2-letter code) |
| `zipCode` | string | - | No | ZIP code for nearby facility search |
| `radius` | integer | `50` | No | Radius in miles for facility search |
| `letterType` | string | - | No | Type of VA letter to get information about |
| `claimType` | string | - | No | Type of VA claim |
| `webhookUrl` | string | - | No | URL to receive results via webhook for automation platforms |
| `demoMode` | boolean | `true` | No | `true` returns the labeled sample. `false` returns the same built-in reference data plus the official-source pointer. Neither mode makes live API calls. |

***

### Pricing

Because this actor returns built-in reference data, it does **not** charge any per-lookup event, in either mode. The per-task events listed on the Pricing tab are never charged. You pay only the standard Actor start fee and the per-result fee shown on the Pricing tab.

***

### Troubleshooting

#### No results or empty dataset

Check the run log for error messages. Common causes:

- Invalid input format (check the examples above)
- The target data doesn't exist or is too small to track

#### How do I test without an API key?

Enable **Demo Mode** in the input. This returns a labeled sample so you can check the output format. No API key is ever needed, because the actor makes no live API calls.

***

**Built by John Rippy | [Actor Arsenal](https://actorarsenal.com)**

# Actor input Schema

## `task` (type: `string`):

The operation to perform on the eBenefits/VA.gov API

## `facilityType` (type: `string`):

Type of VA facility to search for

## `state` (type: `string`):

State for facility search (2-letter code)

## `zipCode` (type: `string`):

ZIP code for nearby facility search

## `radius` (type: `integer`):

Radius in miles for facility search

## `letterType` (type: `string`):

Type of VA letter to get information about

## `claimType` (type: `string`):

Type of VA claim

## `webhookUrl` (type: `string`):

URL to receive results via webhook for automation platforms

## `demoMode` (type: `boolean`):

On: returns a labeled sample. Off: returns the same built-in reference data plus a pointer to the official source. This actor has no live data source, so neither mode makes live API calls.

## Actor input object example

```json
{
  "task": "get_claim_types",
  "radius": 50,
  "demoMode": true
}
```

# Actor output Schema

## `results` (type: `string`):

Claim types, VA letters, facility locations, and benefit information

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "demoMode": true
};

// Run the Actor and wait for it to finish
const run = await client.actor("alizarin_refrigerator-owner/ebenefits-va-gov-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "demoMode": True }

# Run the Actor and wait for it to finish
run = client.actor("alizarin_refrigerator-owner/ebenefits-va-gov-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "demoMode": true
}' |
apify call alizarin_refrigerator-owner/ebenefits-va-gov-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,alizarin_refrigerator-owner/ebenefits-va-gov-api"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/K4gh95vykGsMFfShh/builds/c6p9eSaJXyucuGiqF/openapi.json