How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bureau of Consular Affairs Discovery API

Read-only discovery actions (packages, groups, organizations, tags).

Bureau of Consular Affairs Discovery API is one of 8 APIs that Bureau of Consular Affairs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Discovery. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 13 operations across 13 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against a single base URL, https://cadatacatalog.state.gov/api/3.

13 operations 13 paths 9 schemas 13 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
https://cadatacatalog.state.gov/api/3/action
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Bureau of Consular Affairs Discovery API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiToken).

  • apiToken — CKAN API token, generated from the CKAN user profile.

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 13 GET. Each is listed below with its method, path, parameters, and response codes.

Discovery 13

Read-only discovery actions (packages, groups, organizations, tags).

GET
/action/site_read
Check whether the site is readable
siteRead → 200
GET
/action/package_list
List all dataset (package) names
packageList 2 params → 200
GET
/action/current_package_list_with_resources
List datasets along with their resources
currentPackageListWithResources 3 params → 200
GET
/action/package_show
Retrieve a single dataset (package) by id or name
packageShow 3 params → 200
GET
/action/package_search
Search datasets with Solr query syntax
packageSearch 7 params → 200
GET
/action/resource_show
Retrieve a single resource by id
resourceShow 1 param → 200
GET
/action/resource_search
Search resources within a dataset
resourceSearch 5 params → 200
GET
/action/group_list
List dataset groups
groupList 1 param → 200
GET
/action/group_show
Retrieve a single group
groupShow 2 params → 200
GET
/action/organization_list
List organizations
organizationList 1 param → 200
GET
/action/organization_show
Retrieve a single organization
organizationShow 2 params → 200
GET
/action/tag_list
List tags
tagList 3 params → 200
GET
/action/tag_show
Retrieve a single tag
tagShow 2 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Package (18 properties), Resource (12 properties), SearchResult (3 properties), PackagesResult (3 properties). Each schema is shown below with its type and property counts.

Package
object
18 properties
ListResult
object
3 properties
PackageResult
object
3 properties
Resource
object
12 properties
PackagesResult
object
3 properties
SearchResult
object
3 properties
Result
object
3 properties
SuccessBoolean
object
3 properties
ResourceResult
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bureau-of-consular-affairs-discovery-api-openapi.yml Raw ↑

Other APIs Bureau of Consular Affairs publishes across the network.

Bureau of Consular Affairs Data Catalog (CKAN API)
Travel Advisories API
Passport Issuance Statistics
Embassy and Consulate Locations
Intercountry Adoption Statistics
Bureau of Consular Affairs Datastore API
Bureau of Consular Affairs Write API
Where this information came from

This is an independent, third-party profile of Bureau of Consular Affairs Discovery API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.