---
title: "get a keyword by name"
method: GET
path: "/keywords/{keywordName}"
tags: ["keywords"]
---

# get a keyword by name

`GET /keywords/{keywordName}`

## Path parameters

- `keywordName` string, required

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

OK

- KeywordWithPackages
  - `name` string, required
  - `packages_count` integer, required
  - `packages_url` string, required
  - `related_keywords` Keyword[], required
    - `name` string, required
    - `packages_count` integer, required
    - `packages_url` string, required
  - `packages` Package[], required
    - `id` integer, required
    - `name` string, required
    - `ecosystem` string, required
    - `description` string, nullable, required
    - `homepage` string, nullable, required
    - `licenses` string, nullable, required
    - `normalized_licenses` string[], required
    - `repository_url` string, nullable, required
    - `keywords_array` string[], required
    - `namespace` string, nullable, required
    - `versions_count` integer, required
    - `first_release_published_at` string, date-time, nullable, required
    - `latest_release_published_at` string, date-time, nullable, required
    - `latest_release_number` string, nullable, required
    - `last_synced_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `registry_url` string, nullable, required
    - `documentation_url` string, nullable, required
    - `install_command` string, nullable, required
    - `metadata` object, nullable, required
    - `repo_metadata` object, nullable, required
    - `repo_metadata_updated_at` string, date-time, nullable, required
    - `dependent_packages_count` integer, required
    - `downloads` integer, required
    - `downloads_period` string, nullable, required
    - `dependent_repos_count` integer, required
    - `rankings` object, required
    - `purl` string, required
    - `advisories` Advisory[], required
      - `uuid` string, required
      - `url` string, nullable, required
      - `title` string, nullable, required
      - `description` string, nullable, required
      - `origin` string, nullable, required
      - `severity` string, nullable, required
      - `published_at` string, nullable, required
      - `withdrawn_at` string, nullable, required
      - `classification` string, nullable, required
      - `cvss_score` number, nullable, required
      - `cvss_vector` string, nullable, required
      - `references` string[], required
      - `source_kind` string, nullable, required
      - `identifiers` string[], required
      - `packages` object[], required
      - `created_at` string, required
      - `updated_at` string, required
    - `versions_url` string, required
    - `latest_version_url` string, required
    - `version_numbers_url` string
    - `dependent_packages_url` string, required
    - `related_packages_url` string, required
    - `codemeta_url` string, required
    - `docker_usage_url` string, required
    - `docker_dependents_count` integer, required
    - `docker_downloads_count` integer, required
    - `usage_url` string, required
    - `dependent_repositories_url` string, required
    - `status` string, nullable, required
    - `funding_links` string[], required
    - `maintainers` Maintainer[], required
      - `uuid` string, required
      - `login` string, nullable, required
      - `name` string, nullable, required
      - `email` string, nullable, required
      - `url` string, nullable, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `packages_count` integer, required
      - `packages_url` string, required
      - `total_downloads` integer, required
      - `html_url` string, nullable, required
      - `role` string, nullable, required
    - `critical` boolean, required
    - `issue_metadata` object, required

---

[API](https://skmtc.net/ecosyste-ms/apis/ecosyste-ms-packages.md) · [All operations](https://skmtc.net/ecosyste-ms/apis/ecosyste-ms-packages/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ecosyste-ms/ecosyste-ms-packages/versions/2b4bc337f408/schema)