server_name
stringclasses 156
values | category
stringclasses 1
value | tool
stringlengths 176
38.2k
|
|---|---|---|
flexprice
|
other
|
{'type': 'function', 'name': 'getSubscriptions', 'description': 'Get all subscriptions', 'parameters': {'type': 'object', 'properties': {}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
flexprice
|
other
|
{'type': 'function', 'name': 'getWalletBalance', 'description': 'Get the real-time balance of a wallet', 'parameters': {'type': 'object', 'properties': {'walletId': {'type': 'string'}}, 'required': ['walletId'], 'additionalProperties': False}, 'strict': True}
|
flexprice
|
other
|
{'type': 'function', 'name': 'getWalletById', 'description': 'Get a wallet by ID', 'parameters': {'type': 'object', 'properties': {'walletId': {'type': 'string'}}, 'required': ['walletId'], 'additionalProperties': False}, 'strict': True}
|
flexprice
|
other
|
{'type': 'function', 'name': 'getWalletTransactions', 'description': 'Get transactions for a wallet with pagination', 'parameters': {'type': 'object', 'properties': {'limit': {'type': 'number', 'description': 'Maximum number of transactions to return'}, 'offset': {'type': 'number', 'description': 'Number of transactions to skip for pagination'}, 'walletId': {'type': 'string'}}, 'required': ['walletId'], 'additionalProperties': False}, 'strict': True}
|
flexprice
|
other
|
{'type': 'function', 'name': 'getWalletsByCustomerId', 'description': 'Get all wallets for a customer', 'parameters': {'type': 'object', 'properties': {'customerId': {'type': 'string'}}, 'required': ['customerId'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'add_issue_comment', 'description': 'Add a comment to an existing issue', 'parameters': {'type': 'object', 'properties': {'body': {'type': 'string'}, 'issue_number': {'type': 'number'}, 'owner': {'type': 'string'}, 'repo': {'type': 'string'}}, 'required': ['owner', 'repo', 'issue_number', 'body'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'create_branch', 'description': 'Create a new branch in a GitHub repository', 'parameters': {'type': 'object', 'properties': {'branch': {'type': 'string', 'description': 'Name for the new branch'}, 'from_branch': {'type': 'string', 'description': "Optional: source branch to create from (defaults to the repository's default branch)"}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'branch'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'create_issue', 'description': 'Create a new issue in a GitHub repository', 'parameters': {'type': 'object', 'properties': {'assignees': {'type': 'array', 'items': {'type': 'string'}}, 'body': {'type': 'string'}, 'labels': {'type': 'array', 'items': {'type': 'string'}}, 'milestone': {'type': 'number'}, 'owner': {'type': 'string'}, 'repo': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['owner', 'repo', 'title'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'create_or_update_file', 'description': 'Create or update a single file in a GitHub repository', 'parameters': {'type': 'object', 'properties': {'branch': {'type': 'string', 'description': 'Branch to create/update the file in'}, 'content': {'type': 'string', 'description': 'Content of the file'}, 'message': {'type': 'string', 'description': 'Commit message'}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'path': {'type': 'string', 'description': 'Path where to create/update the file'}, 'repo': {'type': 'string', 'description': 'Repository name'}, 'sha': {'type': 'string', 'description': 'SHA of the file being replaced (required when updating existing files)'}}, 'required': ['owner', 'repo', 'path', 'content', 'message', 'branch'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'create_pull_request', 'description': 'Create a new pull request in a GitHub repository', 'parameters': {'type': 'object', 'properties': {'base': {'type': 'string', 'description': 'The name of the branch you want the changes pulled into'}, 'body': {'type': 'string', 'description': 'Pull request body/description'}, 'draft': {'type': 'boolean', 'description': 'Whether to create the pull request as a draft'}, 'head': {'type': 'string', 'description': 'The name of the branch where your changes are implemented'}, 'maintainer_can_modify': {'type': 'boolean', 'description': 'Whether maintainers can modify the pull request'}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'repo': {'type': 'string', 'description': 'Repository name'}, 'title': {'type': 'string', 'description': 'Pull request title'}}, 'required': ['owner', 'repo', 'title', 'head', 'base'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'create_pull_request_review', 'description': 'Create a review on a pull request', 'parameters': {'type': 'object', 'properties': {'body': {'type': 'string', 'description': 'The body text of the review'}, 'comments': {'type': 'array', 'description': 'Comments to post as part of the review (specify either position or line, not both)', 'items': {'anyOf': [{'type': 'object', 'required': ['path', 'position', 'body'], 'properties': {'body': {'type': 'string', 'description': 'Text of the review comment'}, 'path': {'type': 'string', 'description': 'The relative path to the file being commented on'}, 'position': {'type': 'number', 'description': 'The position in the diff where you want to add a review comment'}}, 'additionalProperties': False}, {'type': 'object', 'required': ['path', 'line', 'body'], 'properties': {'body': {'type': 'string', 'description': 'Text of the review comment'}, 'line': {'type': 'number', 'description': 'The line number in the file where you want to add a review comment'}, 'path': {'type': 'string', 'description': 'The relative path to the file being commented on'}}, 'additionalProperties': False}]}}, 'commit_id': {'type': 'string', 'description': 'The SHA of the commit that needs a review'}, 'event': {'type': 'string', 'description': 'The review action to perform', 'enum': ['APPROVE', 'REQUEST_CHANGES', 'COMMENT']}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'pull_number': {'type': 'number', 'description': 'Pull request number'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'pull_number', 'body', 'event'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'create_repository', 'description': 'Create a new GitHub repository in your account', 'parameters': {'type': 'object', 'properties': {'autoInit': {'type': 'boolean', 'description': 'Initialize with README.md'}, 'description': {'type': 'string', 'description': 'Repository description'}, 'name': {'type': 'string', 'description': 'Repository name'}, 'private': {'type': 'boolean', 'description': 'Whether the repository should be private'}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'fork_repository', 'description': 'Fork a GitHub repository to your account or specified organization', 'parameters': {'type': 'object', 'properties': {'organization': {'type': 'string', 'description': 'Optional: organization to fork to (defaults to your personal account)'}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'get_file_contents', 'description': 'Get the contents of a file or directory from a GitHub repository', 'parameters': {'type': 'object', 'properties': {'branch': {'type': 'string', 'description': 'Branch to get contents from'}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'path': {'type': 'string', 'description': 'Path to the file or directory'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'path'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'get_issue', 'description': 'Get details of a specific issue in a GitHub repository.', 'parameters': {'type': 'object', 'properties': {'issue_number': {'type': 'number'}, 'owner': {'type': 'string'}, 'repo': {'type': 'string'}}, 'required': ['owner', 'repo', 'issue_number'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'get_pull_request', 'description': 'Get details of a specific pull request', 'parameters': {'type': 'object', 'properties': {'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'pull_number': {'type': 'number', 'description': 'Pull request number'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'pull_number'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'get_pull_request_comments', 'description': 'Get the review comments on a pull request', 'parameters': {'type': 'object', 'properties': {'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'pull_number': {'type': 'number', 'description': 'Pull request number'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'pull_number'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'get_pull_request_files', 'description': 'Get the list of files changed in a pull request', 'parameters': {'type': 'object', 'properties': {'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'pull_number': {'type': 'number', 'description': 'Pull request number'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'pull_number'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'get_pull_request_reviews', 'description': 'Get the reviews on a pull request', 'parameters': {'type': 'object', 'properties': {'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'pull_number': {'type': 'number', 'description': 'Pull request number'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'pull_number'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'get_pull_request_status', 'description': 'Get the combined status of all status checks for a pull request', 'parameters': {'type': 'object', 'properties': {'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'pull_number': {'type': 'number', 'description': 'Pull request number'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'pull_number'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'list_commits', 'description': 'Get list of commits of a branch in a GitHub repository', 'parameters': {'type': 'object', 'properties': {'owner': {'type': 'string'}, 'page': {'type': 'number'}, 'perPage': {'type': 'number'}, 'repo': {'type': 'string'}, 'sha': {'type': 'string'}}, 'required': ['owner', 'repo'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'list_issues', 'description': 'List issues in a GitHub repository with filtering options', 'parameters': {'type': 'object', 'properties': {'direction': {'type': 'string', 'enum': ['asc', 'desc']}, 'labels': {'type': 'array', 'items': {'type': 'string'}}, 'owner': {'type': 'string'}, 'page': {'type': 'number'}, 'per_page': {'type': 'number'}, 'repo': {'type': 'string'}, 'since': {'type': 'string'}, 'sort': {'type': 'string', 'enum': ['created', 'updated', 'comments']}, 'state': {'type': 'string', 'enum': ['open', 'closed', 'all']}}, 'required': ['owner', 'repo'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'list_pull_requests', 'description': 'List and filter repository pull requests', 'parameters': {'type': 'object', 'properties': {'base': {'type': 'string', 'description': 'Filter by base branch name'}, 'direction': {'type': 'string', 'description': 'The direction of the sort', 'enum': ['asc', 'desc']}, 'head': {'type': 'string', 'description': 'Filter by head user or head organization and branch name'}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'page': {'type': 'number', 'description': 'Page number of the results'}, 'per_page': {'type': 'number', 'description': 'Results per page (max 100)'}, 'repo': {'type': 'string', 'description': 'Repository name'}, 'sort': {'type': 'string', 'description': 'What to sort results by', 'enum': ['created', 'updated', 'popularity', 'long-running']}, 'state': {'type': 'string', 'description': 'State of the pull requests to return', 'enum': ['open', 'closed', 'all']}}, 'required': ['owner', 'repo'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'merge_pull_request', 'description': 'Merge a pull request', 'parameters': {'type': 'object', 'properties': {'commit_message': {'type': 'string', 'description': 'Extra detail to append to automatic commit message'}, 'commit_title': {'type': 'string', 'description': 'Title for the automatic commit message'}, 'merge_method': {'type': 'string', 'description': 'Merge method to use', 'enum': ['merge', 'squash', 'rebase']}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'pull_number': {'type': 'number', 'description': 'Pull request number'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'pull_number'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'push_files', 'description': 'Push multiple files to a GitHub repository in a single commit', 'parameters': {'type': 'object', 'properties': {'branch': {'type': 'string', 'description': "Branch to push to (e.g., 'main' or 'master')"}, 'files': {'type': 'array', 'description': 'Array of files to push', 'items': {'type': 'object', 'required': ['path', 'content'], 'properties': {'content': {'type': 'string'}, 'path': {'type': 'string'}}, 'additionalProperties': False}}, 'message': {'type': 'string', 'description': 'Commit message'}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'branch', 'files', 'message'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'search_code', 'description': 'Search for code across GitHub repositories', 'parameters': {'type': 'object', 'properties': {'order': {'type': 'string', 'enum': ['asc', 'desc']}, 'page': {'type': 'number', 'minimum': 1}, 'per_page': {'type': 'number', 'minimum': 1, 'maximum': 100}, 'q': {'type': 'string'}}, 'required': ['q'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'search_issues', 'description': 'Search for issues and pull requests across GitHub repositories', 'parameters': {'type': 'object', 'properties': {'order': {'type': 'string', 'enum': ['asc', 'desc']}, 'page': {'type': 'number', 'minimum': 1}, 'per_page': {'type': 'number', 'minimum': 1, 'maximum': 100}, 'q': {'type': 'string'}, 'sort': {'type': 'string', 'enum': ['comments', 'reactions', 'reactions-+1', 'reactions--1', 'reactions-smile', 'reactions-thinking_face', 'reactions-heart', 'reactions-tada', 'interactions', 'created', 'updated']}}, 'required': ['q'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'search_repositories', 'description': 'Search for GitHub repositories', 'parameters': {'type': 'object', 'properties': {'page': {'type': 'number', 'description': 'Page number for pagination (default: 1)'}, 'perPage': {'type': 'number', 'description': 'Number of results per page (default: 30, max: 100)'}, 'query': {'type': 'string', 'description': 'Search query (see GitHub search syntax)'}}, 'required': ['query'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'search_users', 'description': 'Search for users on GitHub', 'parameters': {'type': 'object', 'properties': {'order': {'type': 'string', 'enum': ['asc', 'desc']}, 'page': {'type': 'number', 'minimum': 1}, 'per_page': {'type': 'number', 'minimum': 1, 'maximum': 100}, 'q': {'type': 'string'}, 'sort': {'type': 'string', 'enum': ['followers', 'repositories', 'joined']}}, 'required': ['q'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'update_issue', 'description': 'Update an existing issue in a GitHub repository', 'parameters': {'type': 'object', 'properties': {'assignees': {'type': 'array', 'items': {'type': 'string'}}, 'body': {'type': 'string'}, 'issue_number': {'type': 'number'}, 'labels': {'type': 'array', 'items': {'type': 'string'}}, 'milestone': {'type': 'number'}, 'owner': {'type': 'string'}, 'repo': {'type': 'string'}, 'state': {'type': 'string', 'enum': ['open', 'closed']}, 'title': {'type': 'string'}}, 'required': ['owner', 'repo', 'issue_number'], 'additionalProperties': False}, 'strict': True}
|
github
|
other
|
{'type': 'function', 'name': 'update_pull_request_branch', 'description': 'Update a pull request branch with the latest changes from the base branch', 'parameters': {'type': 'object', 'properties': {'expected_head_sha': {'type': 'string', 'description': "The expected SHA of the pull request's HEAD ref"}, 'owner': {'type': 'string', 'description': 'Repository owner (username or organization)'}, 'pull_number': {'type': 'number', 'description': 'Pull request number'}, 'repo': {'type': 'string', 'description': 'Repository name'}}, 'required': ['owner', 'repo', 'pull_number'], 'additionalProperties': False}, 'strict': True}
|
github-chat
|
other
|
{'type': 'function', 'name': 'index_repository', 'description': 'Index a GitHub repository to analyze its codebase. This must be done before asking questions about the repository.', 'parameters': {'type': 'object', 'properties': {'repo_url': {'type': 'string', 'title': 'Repo Url', 'description': 'The GitHub repository URL to index (format: https://github.com/username/repo).'}}, 'required': ['repo_url'], 'additionalProperties': False}, 'strict': True}
|
github-chat
|
other
|
{'type': 'function', 'name': 'query_repository', 'description': 'Ask questions about a GitHub repository and receive detailed AI responses. The repository must be indexed first.', 'parameters': {'type': 'object', 'properties': {'conversation_history': {'title': 'Conversation History', 'description': 'Previous conversation history for multi-turn conversations.', 'default': None, 'anyOf': [{'type': 'array', 'items': {'type': 'object', 'additionalProperties': {'type': 'string'}}}, {'type': 'null'}]}, 'question': {'type': 'string', 'title': 'Question', 'description': 'The question to ask about the repository.'}, 'repo_url': {'type': 'string', 'title': 'Repo Url', 'description': 'The GitHub repository URL to query (format: https://github.com/username/repo).'}}, 'required': ['repo_url', 'question'], 'additionalProperties': False}, 'strict': True}
|
gitlab
|
other
|
{'type': 'function', 'name': 'create_branch', 'description': 'Create a new branch in a GitLab project', 'parameters': {'type': 'object', 'properties': {'branch': {'type': 'string', 'description': 'Name for the new branch'}, 'project_id': {'type': 'string', 'description': 'Project ID or URL-encoded path'}, 'ref': {'type': 'string', 'description': 'Source branch/commit for new branch'}}, 'required': ['project_id', 'branch'], 'additionalProperties': False}, 'strict': True}
|
gitlab
|
other
|
{'type': 'function', 'name': 'create_issue', 'description': 'Create a new issue in a GitLab project', 'parameters': {'type': 'object', 'properties': {'assignee_ids': {'type': 'array', 'description': 'Array of user IDs to assign', 'items': {'type': 'number'}}, 'description': {'type': 'string', 'description': 'Issue description'}, 'labels': {'type': 'array', 'description': 'Array of label names', 'items': {'type': 'string'}}, 'milestone_id': {'type': 'number', 'description': 'Milestone ID to assign'}, 'project_id': {'type': 'string', 'description': 'Project ID or URL-encoded path'}, 'title': {'type': 'string', 'description': 'Issue title'}}, 'required': ['project_id', 'title'], 'additionalProperties': False}, 'strict': True}
|
gitlab
|
other
|
{'type': 'function', 'name': 'create_merge_request', 'description': 'Create a new merge request in a GitLab project', 'parameters': {'type': 'object', 'properties': {'allow_collaboration': {'type': 'boolean', 'description': 'Allow commits from upstream members'}, 'description': {'type': 'string', 'description': 'Merge request description'}, 'draft': {'type': 'boolean', 'description': 'Create as draft merge request'}, 'project_id': {'type': 'string', 'description': 'Project ID or URL-encoded path'}, 'source_branch': {'type': 'string', 'description': 'Branch containing changes'}, 'target_branch': {'type': 'string', 'description': 'Branch to merge into'}, 'title': {'type': 'string', 'description': 'Merge request title'}}, 'required': ['project_id', 'title', 'source_branch', 'target_branch'], 'additionalProperties': False}, 'strict': True}
|
gitlab
|
other
|
{'type': 'function', 'name': 'create_or_update_file', 'description': 'Create or update a single file in a GitLab project', 'parameters': {'type': 'object', 'properties': {'branch': {'type': 'string', 'description': 'Branch to create/update the file in'}, 'commit_message': {'type': 'string', 'description': 'Commit message'}, 'content': {'type': 'string', 'description': 'Content of the file'}, 'file_path': {'type': 'string', 'description': 'Path where to create/update the file'}, 'previous_path': {'type': 'string', 'description': 'Path of the file to move/rename'}, 'project_id': {'type': 'string', 'description': 'Project ID or URL-encoded path'}}, 'required': ['project_id', 'file_path', 'content', 'commit_message', 'branch'], 'additionalProperties': False}, 'strict': True}
|
gitlab
|
other
|
{'type': 'function', 'name': 'create_repository', 'description': 'Create a new GitLab project', 'parameters': {'type': 'object', 'properties': {'description': {'type': 'string', 'description': 'Repository description'}, 'initialize_with_readme': {'type': 'boolean', 'description': 'Initialize with README.md'}, 'name': {'type': 'string', 'description': 'Repository name'}, 'visibility': {'type': 'string', 'description': 'Repository visibility level', 'enum': ['private', 'internal', 'public']}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
gitlab
|
other
|
{'type': 'function', 'name': 'fork_repository', 'description': 'Fork a GitLab project to your account or specified namespace', 'parameters': {'type': 'object', 'properties': {'namespace': {'type': 'string', 'description': 'Namespace to fork to (full path)'}, 'project_id': {'type': 'string', 'description': 'Project ID or URL-encoded path'}}, 'required': ['project_id'], 'additionalProperties': False}, 'strict': True}
|
gitlab
|
other
|
{'type': 'function', 'name': 'get_file_contents', 'description': 'Get the contents of a file or directory from a GitLab project', 'parameters': {'type': 'object', 'properties': {'file_path': {'type': 'string', 'description': 'Path to the file or directory'}, 'project_id': {'type': 'string', 'description': 'Project ID or URL-encoded path'}, 'ref': {'type': 'string', 'description': 'Branch/tag/commit to get contents from'}}, 'required': ['project_id', 'file_path'], 'additionalProperties': False}, 'strict': True}
|
gitlab
|
other
|
{'type': 'function', 'name': 'push_files', 'description': 'Push multiple files to a GitLab project in a single commit', 'parameters': {'type': 'object', 'properties': {'branch': {'type': 'string', 'description': 'Branch to push to'}, 'commit_message': {'type': 'string', 'description': 'Commit message'}, 'files': {'type': 'array', 'description': 'Array of files to push', 'items': {'type': 'object', 'required': ['file_path', 'content'], 'properties': {'content': {'type': 'string', 'description': 'Content of the file'}, 'file_path': {'type': 'string', 'description': 'Path where to create the file'}}, 'additionalProperties': False}}, 'project_id': {'type': 'string', 'description': 'Project ID or URL-encoded path'}}, 'required': ['project_id', 'branch', 'files', 'commit_message'], 'additionalProperties': False}, 'strict': True}
|
gitlab
|
other
|
{'type': 'function', 'name': 'search_repositories', 'description': 'Search for GitLab projects', 'parameters': {'type': 'object', 'properties': {'page': {'type': 'number', 'description': 'Page number for pagination (default: 1)'}, 'per_page': {'type': 'number', 'description': 'Number of results per page (default: 20)'}, 'search': {'type': 'string', 'description': 'Search query'}}, 'required': ['search'], 'additionalProperties': False}, 'strict': True}
|
gitmcp
|
other
|
{'type': 'function', 'name': 'fetch_generic_documentation', 'description': 'Fetch documentation for any GitHub repository by providing owner and project name', 'parameters': {'type': 'object', 'properties': {'owner': {'type': 'string', 'description': 'The GitHub repository owner (username or organization)'}, 'repo': {'type': 'string', 'description': 'The GitHub repository name'}}, 'required': ['owner', 'repo'], 'additionalProperties': False}, 'strict': True}
|
gitmcp
|
other
|
{'type': 'function', 'name': 'fetch_generic_url_content', 'description': 'Generic tool to fetch content from any absolute URL, respecting robots.txt rules. Use this to retrieve referenced urls (absolute urls) that were mentioned in previously fetched documentation.', 'parameters': {'type': 'object', 'properties': {'url': {'type': 'string', 'description': 'The URL of the document or page to fetch'}}, 'required': ['url'], 'additionalProperties': False}, 'strict': True}
|
gitmcp
|
other
|
{'type': 'function', 'name': 'match_common_libs_owner_repo_mapping', 'description': "Match a library name to an owner/repo. Don't use it if you have an owner and repo already. Use this first if only a library name was provided. If found - you can use owner and repo to call other tools. If not found - try to use the library name directly in other tools.", 'parameters': {'type': 'object', 'properties': {'library': {'type': 'string', 'description': 'The name of the library to try and match to an owner/repo.'}}, 'required': ['library'], 'additionalProperties': False}, 'strict': True}
|
gitmcp
|
other
|
{'type': 'function', 'name': 'search_generic_code', 'description': 'Search for code in any GitHub repository by providing owner, project name, and search query. Returns matching files. Supports pagination with 30 results per page.', 'parameters': {'type': 'object', 'properties': {'owner': {'type': 'string', 'description': 'The GitHub repository owner (username or organization)'}, 'page': {'type': 'number', 'description': 'Page number to retrieve (starting from 1). Each page contains 30 results.'}, 'query': {'type': 'string', 'description': 'The search query to find relevant code files'}, 'repo': {'type': 'string', 'description': 'The GitHub repository name'}}, 'required': ['owner', 'repo', 'query'], 'additionalProperties': False}, 'strict': True}
|
gitmcp
|
other
|
{'type': 'function', 'name': 'search_generic_documentation', 'description': 'Semantically search in documentation for any GitHub repository by providing owner, project name, and search query. Useful for specific queries.', 'parameters': {'type': 'object', 'properties': {'owner': {'type': 'string', 'description': 'The GitHub repository owner (username or organization)'}, 'query': {'type': 'string', 'description': 'The search query to find relevant documentation'}, 'repo': {'type': 'string', 'description': 'The GitHub repository name'}}, 'required': ['owner', 'repo', 'query'], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'glif_info', 'description': 'Get detailed information about a glif including input fields', 'parameters': {'type': 'object', 'properties': {'id': {'type': 'string', 'description': 'The ID of the glif to show details for'}}, 'required': ['id'], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'list_featured_glifs', 'description': 'Get a curated list of featured glifs', 'parameters': {'type': 'object', 'properties': {}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'list_saved_glif_tools', 'description': 'List all saved glif tools', 'parameters': {'type': 'object', 'properties': {}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'my_glif_user_info', 'description': 'Get detailed information about your user account, recent glifs, and recent runs', 'parameters': {'type': 'object', 'properties': {}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'my_glifs', 'description': 'Get a list of your glifs', 'parameters': {'type': 'object', 'properties': {}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'remove_all_glif_tools', 'description': 'Remove all saved glif tools and return to a pristine state', 'parameters': {'type': 'object', 'properties': {}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'remove_glif_tool', 'description': 'Remove a saved glif tool', 'parameters': {'type': 'object', 'properties': {'toolName': {'type': 'string', 'description': 'The tool name of the saved glif to remove'}}, 'required': ['toolName'], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'run_glif', 'description': 'Run a glif with the specified ID and inputs', 'parameters': {'type': 'object', 'properties': {'id': {'type': 'string', 'description': 'The ID of the glif to run'}, 'inputs': {'type': 'array', 'description': 'Array of input values for the glif', 'items': {'type': 'string'}}}, 'required': ['id', 'inputs'], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'save_glif_as_tool', 'description': 'Save a glif as a custom tool', 'parameters': {'type': 'object', 'properties': {'description': {'type': 'string', 'description': 'Optional custom description (defaults to glif description)'}, 'id': {'type': 'string', 'description': 'The ID of the glif to save'}, 'name': {'type': 'string', 'description': 'Optional custom name for the tool (defaults to glif name)'}, 'toolName': {'type': 'string', 'description': 'The name to use for the tool (must be unique)'}}, 'required': ['id', 'toolName'], 'additionalProperties': False}, 'strict': True}
|
glif
|
other
|
{'type': 'function', 'name': 'search_glifs', 'description': 'Search for glifs by query string', 'parameters': {'type': 'object', 'properties': {'query': {'type': 'string', 'description': 'Search query string'}}, 'required': ['query'], 'additionalProperties': False}, 'strict': True}
|
google-maps
|
other
|
{'type': 'function', 'name': 'maps_directions', 'description': 'Get directions between two points', 'parameters': {'type': 'object', 'properties': {'destination': {'type': 'string', 'description': 'Ending point address or coordinates'}, 'mode': {'type': 'string', 'description': 'Travel mode (driving, walking, bicycling, transit)', 'enum': ['driving', 'walking', 'bicycling', 'transit']}, 'origin': {'type': 'string', 'description': 'Starting point address or coordinates'}}, 'required': ['origin', 'destination'], 'additionalProperties': False}, 'strict': True}
|
google-maps
|
other
|
{'type': 'function', 'name': 'maps_distance_matrix', 'description': 'Calculate travel distance and time for multiple origins and destinations', 'parameters': {'type': 'object', 'properties': {'destinations': {'type': 'array', 'description': 'Array of destination addresses or coordinates', 'items': {'type': 'string'}}, 'mode': {'type': 'string', 'description': 'Travel mode (driving, walking, bicycling, transit)', 'enum': ['driving', 'walking', 'bicycling', 'transit']}, 'origins': {'type': 'array', 'description': 'Array of origin addresses or coordinates', 'items': {'type': 'string'}}}, 'required': ['origins', 'destinations'], 'additionalProperties': False}, 'strict': True}
|
google-maps
|
other
|
{'type': 'function', 'name': 'maps_elevation', 'description': 'Get elevation data for locations on the earth', 'parameters': {'type': 'object', 'properties': {'locations': {'type': 'array', 'description': 'Array of locations to get elevation for', 'items': {'type': 'object', 'required': ['latitude', 'longitude'], 'properties': {'latitude': {'type': 'number'}, 'longitude': {'type': 'number'}}}}}, 'required': ['locations'], 'additionalProperties': False}, 'strict': True}
|
google-maps
|
other
|
{'type': 'function', 'name': 'maps_geocode', 'description': 'Convert an address into geographic coordinates', 'parameters': {'type': 'object', 'properties': {'address': {'type': 'string', 'description': 'The address to geocode'}}, 'required': ['address'], 'additionalProperties': False}, 'strict': True}
|
google-maps
|
other
|
{'type': 'function', 'name': 'maps_place_details', 'description': 'Get detailed information about a specific place', 'parameters': {'type': 'object', 'properties': {'place_id': {'type': 'string', 'description': 'The place ID to get details for'}}, 'required': ['place_id'], 'additionalProperties': False}, 'strict': True}
|
google-maps
|
other
|
{'type': 'function', 'name': 'maps_reverse_geocode', 'description': 'Convert coordinates into an address', 'parameters': {'type': 'object', 'properties': {'latitude': {'type': 'number', 'description': 'Latitude coordinate'}, 'longitude': {'type': 'number', 'description': 'Longitude coordinate'}}, 'required': ['latitude', 'longitude'], 'additionalProperties': False}, 'strict': True}
|
google-maps
|
other
|
{'type': 'function', 'name': 'maps_search_places', 'description': 'Search for places using Google Places API', 'parameters': {'type': 'object', 'properties': {'location': {'type': 'object', 'description': 'Optional center point for the search', 'properties': {'latitude': {'type': 'number'}, 'longitude': {'type': 'number'}}}, 'query': {'type': 'string', 'description': 'Search query'}, 'radius': {'type': 'number', 'description': 'Search radius in meters (max 50000)'}}, 'required': ['query'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'active-user-series', 'description': 'Retrieves time-series data of active users. Available in daily, weekly, and monthly units.', 'parameters': {'type': 'object', 'properties': {'date': {'type': 'string', 'description': 'End date in YYYY-MM-DD format.'}, 'unit': {'type': 'string', 'enum': ['DAY', 'WEEK', 'MONTH']}}, 'required': ['unit'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'analytics-chart-detail', 'description': "fetch analytics chart detail. You can visualize the chart using this tool's result.", 'parameters': {'type': 'object', 'properties': {'chartId': {'type': 'number', 'description': 'Chart id', 'exclusiveMinimum': 0}, 'chartType': {'type': 'string', 'description': "Type of the chart. Will throw an error if given chartId's chart type is different from chartType.", 'enum': ['FUNNEL', 'DATA_INSIGHT', 'RETENTION', 'USER_PATH']}}, 'required': ['chartId', 'chartType'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'analytics-chart-list', 'description': 'fetch data analytics chart list.', 'parameters': {'type': 'object', 'properties': {'chartType': {'type': 'string', 'enum': ['FUNNEL', 'DATA_INSIGHT', 'RETENTION', 'USER_PATH']}, 'pageNumber': {'type': 'number', 'default': 1}, 'pageSize': {'type': 'number', 'default': 100}, 'searchKeyword': {'type': 'string'}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'data-report-detail', 'description': 'fetch data report detail.', 'parameters': {'type': 'object', 'properties': {'dataReportId': {'type': 'number', 'exclusiveMinimum': 0}}, 'required': ['dataReportId'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'data-report-list', 'description': 'fetch data report list.', 'parameters': {'type': 'object', 'properties': {}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'experiment-detail', 'description': 'Retrieves detailed information for a specific A/B test experiment.', 'parameters': {'type': 'object', 'properties': {'experimentId': {'type': 'number'}}, 'required': ['experimentId'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'experiment-list', 'description': 'Fetches a paginated list of A/B test experiments with search functionality.', 'parameters': {'type': 'object', 'properties': {'pageNumber': {'type': 'number', 'default': 1}, 'pageSize': {'type': 'number', 'default': 100}, 'searchKeyword': {'type': 'string', 'description': 'name, description, or experimentKey of an experiment.'}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'in-app-message-detail', 'description': 'Retrieves detailed information for a specific in-app message.', 'parameters': {'type': 'object', 'properties': {'inAppMessageId': {'type': 'number'}}, 'required': ['inAppMessageId'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'in-app-message-list', 'description': 'Fetches a paginated list of in-app messages with search functionality.', 'parameters': {'type': 'object', 'properties': {'pageNumber': {'type': 'number', 'default': 1}, 'pageSize': {'type': 'number', 'default': 100}, 'searchKeyword': {'type': 'string', 'description': 'name, description, or campaignKey of an in-app message.'}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'push-message-detail', 'description': 'Retrieves detailed information for a specific push message.', 'parameters': {'type': 'object', 'properties': {'pushMessageId': {'type': 'number'}}, 'required': ['pushMessageId'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'push-message-list', 'description': 'Fetches a paginated list of push messages with search functionality.', 'parameters': {'type': 'object', 'properties': {'pageNumber': {'type': 'number', 'default': 1}, 'pageSize': {'type': 'number', 'default': 100}, 'searchKeyword': {'type': 'string', 'description': 'name, description, or campaignKey of a push message.'}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'remote-config-create', 'description': 'Creates an empty remote config. It is recommended to update an existing RC first if there is an associated RC with the one you want to create since the total number of RC is limited.', 'parameters': {'type': 'object', 'properties': {'body': {'type': 'object', 'required': ['key', 'dataType'], 'properties': {'dataType': {'type': 'string', 'description': "Type of Remote Config's value.", 'enum': ['STRING', 'JSON', 'NUMBER', 'BOOLEAN']}, 'description': {'type': 'string'}, 'key': {'type': 'string', 'description': "Remote config's name.", 'minLength': 1}, 'userIdentifierCriteria': {'type': 'string', 'description': 'User identifier criteria for targeting. You can use criteria provided by Hackle($deviceId, $userId) or your own criteria created at Hackle dashboard website.', 'default': '$deviceId'}}, 'additionalProperties': False}}, 'required': ['body'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'remote-config-detail', 'description': 'Fetch remote config detail.', 'parameters': {'type': 'object', 'properties': {'remoteConfigId': {'type': 'number', 'description': "Remote config's id. You can get this information by using Remote Config List Tool.", 'exclusiveMinimum': 0}}, 'required': ['remoteConfigId'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'remote-config-list', 'description': 'Fetch Remote Config list.', 'parameters': {'type': 'object', 'properties': {'pageNumber': {'type': 'number', 'default': 1}, 'pageSize': {'type': 'number', 'default': 100}, 'searchKeyword': {'type': 'string'}, 'status': {'type': 'string', 'default': 'ACTIVE', 'enum': ['ACTIVE', 'ARCHIVED']}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'remote-config-update', 'description': "Updates remote config's content.", 'parameters': {'type': 'object', 'properties': {'body': {'type': 'object', 'required': ['dataType', 'remoteConfigDefaultValue', 'conditionalValues'], 'properties': {'conditionalValues': {'type': 'array', 'description': 'The earlier a condition is placed in the array, the earlier it is applied.', 'items': {'type': 'object', 'required': ['ruleName', 'remoteConfigValue', 'target'], 'properties': {'remoteConfigValue': {'type': ['string', 'number', 'boolean']}, 'ruleName': {'type': 'string'}, 'target': {'type': 'object', 'description': 'Targeting rule.', 'required': ['conditions'], 'properties': {'conditions': {'type': 'array', 'description': "Users who The user he satisfies all conditions in this array will see this rule's remote config value.", 'items': {'type': 'object', 'required': ['key', 'match'], 'properties': {'key': {'type': 'object', 'required': ['type', 'name'], 'properties': {'name': {'type': 'string', 'description': "Property's name if type is HACKLE_PROPERTY or USER_PROPERTY. Experiment key if type is AB_TEST. Feature flag key if type is FEATURE_FLAG. You can put any non-empty string if type is COHORT or SEGMENT."}, 'type': {'type': 'string', 'description': "Condition's type.", 'enum': ['HACKLE_PROPERTY', 'USER_PROPERTY', 'SEGMENT', 'AB_TEST', 'FEATURE_FLAG', 'COHORT']}}, 'additionalProperties': False}, 'match': {'type': 'object', 'required': ['operator', 'valueType', 'values'], 'properties': {'operator': {'type': 'string', 'enum': ['IS_ONE_OF', 'IS_NOT_ONE_OF', 'IS_STARTS_WITH', 'IS_NOT_STARTS_WITH', 'IS_ENDS_WITH', 'IS_NOT_ENDS_WITH', 'IS_CONTAINS', 'IS_NOT_CONTAINS', 'EQ', 'NOT_EQ', 'GT', 'GTE', 'LT', 'LTE', 'IS_TRUE', 'IS_FALSE', 'VERSION_EQ', 'VERSION_NOT_EQ', 'VERSION_GT', 'VERSION_GTE', 'VERSION_LT', 'VERSION_LTE']}, 'valueType': {'type': 'string', 'enum': ['NUMBER', 'STRING', 'BOOLEAN', 'VERSION']}, 'values': {'type': 'array', 'description': "Values of targeting condition's key. Followings are some special cases: The values will be treated as names if you are using SEGMENT. Only strings 'A' and 'B' are allowed if type is AB_TEST. Only boolean values are accepted if type is FEATURE_FLAG. You should put cohort's id if type is COHORT.", 'items': {'type': ['string', 'number', 'boolean']}}}, 'additionalProperties': False}}, 'additionalProperties': False}}}, 'additionalProperties': False}}, 'additionalProperties': False}}, 'dataType': {'type': 'string', 'description': "Type of Remote Config's value. You must provide remote config's value type to match with this field.", 'enum': ['STRING', 'JSON', 'NUMBER', 'BOOLEAN']}, 'remoteConfigDefaultValue': {'type': ['string', 'number', 'boolean']}}, 'additionalProperties': False}, 'remoteConfigId': {'type': 'number', 'description': "Remote config's id.", 'exclusiveMinimum': 0}}, 'required': ['remoteConfigId', 'body'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'remote-config-update-description', 'description': "Updates remote config's description. The change will be applied to both production and development environment.", 'parameters': {'type': 'object', 'properties': {'body': {'type': 'object', 'required': ['description'], 'properties': {'description': {'type': 'string'}}, 'additionalProperties': False}, 'remoteConfigId': {'type': 'number', 'description': "Remote config's id.", 'exclusiveMinimum': 0}}, 'required': ['remoteConfigId', 'body'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'remote-config-update-user-identifier-criteria', 'description': "Updates remote config's user identifier criteria. The change will be applied to both production and development environment.", 'parameters': {'type': 'object', 'properties': {'body': {'type': 'object', 'required': ['userIdentifierCriteria'], 'properties': {'userIdentifierCriteria': {'type': 'string', 'description': 'User identifier criteria for targeting. You can use criteria provided by Hackle($deviceId, $userId) or your own criteria created at Hackle dashboard website.'}}, 'additionalProperties': False}, 'remoteConfigId': {'type': 'number', 'description': "Remote config's id.", 'exclusiveMinimum': 0}}, 'required': ['remoteConfigId', 'body'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'retention-series', 'description': 'Retrieves time-series data of user retention. Available in daily, weekly, and monthly units.', 'parameters': {'type': 'object', 'properties': {'date': {'type': 'string', 'description': 'End date in YYYY-MM-DD format.'}, 'unit': {'type': 'string', 'enum': ['DAY', 'WEEK', 'MONTH']}}, 'required': ['unit'], 'additionalProperties': False}, 'strict': True}
|
hackle
|
other
|
{'type': 'function', 'name': 'stickiness-series', 'description': 'Retrieves time-series data of user stickiness (return visit frequency). Available in weekly and monthly units.', 'parameters': {'type': 'object', 'properties': {'date': {'type': 'string', 'description': 'End date in YYYY-MM-DD format.'}, 'unit': {'type': 'string', 'enum': ['WEEK', 'MONTH']}}, 'required': ['unit'], 'additionalProperties': False}, 'strict': True}
|
handwriting-ocr
|
other
|
{'type': 'function', 'name': 'check_status', 'description': 'Check the status of a document', 'parameters': {'type': 'object', 'properties': {'id': {'type': 'string', 'description': 'Document ID'}}, 'required': ['id'], 'additionalProperties': False}, 'strict': True}
|
handwriting-ocr
|
other
|
{'type': 'function', 'name': 'get_text', 'description': 'Retrieve the transcribed text from a document', 'parameters': {'type': 'object', 'properties': {'id': {'type': 'string', 'description': 'Document ID'}}, 'required': ['id'], 'additionalProperties': False}, 'strict': True}
|
handwriting-ocr
|
other
|
{'type': 'function', 'name': 'upload_document', 'description': 'Upload a document to Handwriting OCR API for transcription', 'parameters': {'type': 'object', 'properties': {'delete_after': {'type': 'integer', 'description': 'Seconds until auto-deletion (optional)'}, 'extractor_id': {'type': 'string', 'description': 'Extractor ID (required if action is extractor, will be ignored)'}, 'file': {'type': 'string', 'description': 'Path to the document (PDF, JPG, PNG, etc.)'}, 'prompt_id': {'type': 'string', 'description': 'Prompt ID (requires Enterprise subscription, will be ignored)'}}, 'required': ['file'], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'affected_people_humanitarian_needs_get', 'description': 'OCHA\'s Humanitarian Needs data, based on the Joint and Intersectoral Analysis Framework (JIAF), provides information about the number of people in need during a crisis. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/affected_people/#humanitarian-needs">HDX HAPI documentation</a>, and the <a href="https://www.jiaf.info/">original JIAF source</a> website.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **category**: A category combining gender, age range, disability marker and population group information\n\n- **sector_code**: Filter the response by the sector code.\n\n- **population_status**: Filter the response by the population status, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#population-status">here.</a>\n\n- **population_min**: Filter the response by a lower bound for the population.\n\n- **population_max**: Filter the response by a upper bound for the population.\n\n- **sector_name**: Filter the response by the sector name.\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin_level**: Filter the response by admin level.\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "location_code": "string",\n "location_name": "string",\n "admin1_code": "unknown_type",\n "reference_period_start": "2024-01-01T12:00:00Z",\n "sector_name": "unknown_type",\n "admin2_code": "unknown_type",\n "admin_level": 1,\n "category": "string",\n "admin2_name": "unknown_type",\n "population": 1,\n "admin1_name": "unknown_type",\n "reference_period_end": "unknown_type",\n "sector_code": "string",\n "resource_hdx_id": "string",\n "population_status": "AFF"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'admin1_code': {'title': 'Admin1 Code', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin1_name': {'title': 'Admin1 Name', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin2_code': {'title': 'Admin2 Code', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin2_name': {'title': 'Admin2 Name', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin_level': {'title': 'Admin Level', 'description': 'Filter the response by admin level.', 'anyOf': [{'type': 'string', 'title': 'AdminLevel', 'enum': ['0', '1', '2']}, {'type': 'null'}]}, 'category': {'title': 'Category', 'description': 'A category combining gender, age range, disability marker and population group information', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'population_max': {'title': 'Population Max', 'description': 'Filter the response by a upper bound for the population.', 'anyOf': [{'type': 'integer'}, {'type': 'null'}]}, 'population_min': {'title': 'Population Min', 'description': 'Filter the response by a lower bound for the population.', 'anyOf': [{'type': 'integer'}, {'type': 'null'}]}, 'population_status': {'title': 'Population Status', 'description': 'Filter the response by the population status, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#population-status">here.</a>', 'anyOf': [{'type': 'string', 'title': 'PopulationStatus', 'enum': ['AFF', 'INN', 'TGT', 'REA', 'all'], 'maxLength': 32}, {'type': 'null'}]}, 'sector_code': {'title': 'Sector Code', 'description': 'Filter the response by the sector code.', 'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}]}, 'sector_name': {'title': 'Sector Name', 'description': 'Filter the response by the sector name.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'affected_people_idps_get', 'description': 'Get idps data\n\n🎯 **CRITICAL - Data Coverage Warning**: Data coverage is only determined by the metadata_data_availability_get tool. Just because a country is in the system doesn\'t mean it has data. ALWAYS verify data availability before making data queries. \n\n🎯 **CRITICAL - Administrative Level Efficiency**: Before making aggregate queries (totals, country-wide statistics), ALWAYS check data availability using metadata_data_availability_get for the target country. Use the LOWEST available admin level (0=country, 1=state, 2=district) to avoid downloading excessive granular data. For country totals, use admin level 0 if available, otherwise level 1. Never query admin level 2 for simple aggregations when level 0/1 is sufficient.\n\n🔄 **Pagination**: You can page through results using `limit` and `offset` parameters (limit=records per page, offset=starting position).\n\n⚠️ **CRITICAL - Never Manually Aggregate Data**: IMPORTANT: Never sum data yourself, only take the data verbatim from the tool. NEVER aggregate totals yourself to answer a question if you do not have the values already aggregated from the tool. Do NOT sum up individual records, calculate country-wide statistics from subnational data, or aggregate across time periods/demographics yourself. If data is not pre-aggregated, inform the user that aggregate data is not available. Always use the most appropriate administrative level that has pre-aggregated data.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin_level**: Filter the response by admin level.\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "location_code": "string",\n "location_name": "string",\n "admin1_code": "unknown_type",\n "reference_period_start": "2024-01-01T12:00:00Z",\n "reporting_round": 1,\n "operation": "string",\n "admin2_code": "unknown_type",\n "admin_level": 1,\n "admin2_name": "unknown_type",\n "population": 1,\n "admin1_name": "unknown_type",\n "reference_period_end": "unknown_type",\n "resource_hdx_id": "string",\n "assessment_type": "BA"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'admin1_code': {'title': 'Admin1 Code', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin1_name': {'title': 'Admin1 Name', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin2_code': {'title': 'Admin2 Code', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin2_name': {'title': 'Admin2 Name', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin_level': {'title': 'Admin Level', 'description': 'Filter the response by admin level.', 'anyOf': [{'type': 'string', 'title': 'AdminLevel', 'enum': ['0', '1', '2']}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'affected_people_refugees_get', 'description': 'UNHCR\'s Refugee data provides information about displaced people in a crisis. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/affected_people/#refugees-persons-of-concern">HDX HAPI documentation</a>, and the <a href="https://data.humdata.org/dataset/unhcr-population-data-for-world">original HDX source</a> website.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **population_group**: Filter the response by the population group, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#population-group">here.</a>\n\n- **population_min**: Filter the response by a lower bound for the population.\n\n- **population_max**: Filter the response by a upper bound for the population.\n\n- **gender**: Filter the response by the gender, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#gender">here.</a>\n\n- **age_range**: Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data.\n\n- **origin_location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **origin_location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **origin_has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **origin_in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **asylum_location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **asylum_location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **asylum_has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **asylum_in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "resource_hdx_id": "string",\n "population_group": "REF",\n "gender": "f",\n "reference_period_start": "2024-01-01T12:00:00Z",\n "asylum_location_name": "string",\n "min_age": "unknown_type",\n "max_age": "unknown_type",\n "population": 1,\n "origin_location_code": "string",\n "reference_period_end": "unknown_type",\n "origin_location_name": "string",\n "asylum_location_code": "string",\n "age_range": "string"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'age_range': {'title': 'Age Range', 'description': 'Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data.', 'default': 'all', 'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}]}, 'asylum_has_hrp': {'title': 'Asylum Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'asylum_in_gho': {'title': 'Asylum In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'asylum_location_code': {'title': 'Asylum Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'asylum_location_name': {'title': 'Asylum Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'gender': {'title': 'Gender', 'description': 'Filter the response by the gender, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#gender">here.</a>', 'default': 'all', 'anyOf': [{'type': 'string', 'title': 'Gender', 'enum': ['f', 'm', 'x', 'u', 'o', 'all'], 'maxLength': 3}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'origin_has_hrp': {'title': 'Origin Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'origin_in_gho': {'title': 'Origin In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'origin_location_code': {'title': 'Origin Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'origin_location_name': {'title': 'Origin Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'population_group': {'title': 'Population Group', 'description': 'Filter the response by the population group, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#population-group">here.</a>', 'anyOf': [{'type': 'string', 'title': 'PopulationGroup', 'enum': ['REF', 'ROC', 'ASY', 'OIP', 'IDP', 'IOC', 'STA', 'OOC', 'HST', 'RET', 'RST', 'NAT', 'RDP', 'RRI', 'all'], 'maxLength': 32}, {'type': 'null'}]}, 'population_max': {'title': 'Population Max', 'description': 'Filter the response by a upper bound for the population.', 'anyOf': [{'type': 'integer'}, {'type': 'null'}]}, 'population_min': {'title': 'Population Min', 'description': 'Filter the response by a lower bound for the population.', 'anyOf': [{'type': 'integer'}, {'type': 'null'}]}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'affected_people_returnees_get', 'description': 'Get returnees data\n\n🎯 **CRITICAL - Data Coverage Warning**: Data coverage is only determined by the metadata_data_availability_get tool. Just because a country is in the system doesn\'t mean it has data. ALWAYS verify data availability before making data queries. \n\n🎯 **CRITICAL - Administrative Level Efficiency**: Before making aggregate queries (totals, country-wide statistics), ALWAYS check data availability using metadata_data_availability_get for the target country. Use the LOWEST available admin level (0=country, 1=state, 2=district) to avoid downloading excessive granular data. For country totals, use admin level 0 if available, otherwise level 1. Never query admin level 2 for simple aggregations when level 0/1 is sufficient.\n\n🔄 **Pagination**: You can page through results using `limit` and `offset` parameters (limit=records per page, offset=starting position).\n\n⚠️ **CRITICAL - Never Manually Aggregate Data**: IMPORTANT: Never sum data yourself, only take the data verbatim from the tool. NEVER aggregate totals yourself to answer a question if you do not have the values already aggregated from the tool. Do NOT sum up individual records, calculate country-wide statistics from subnational data, or aggregate across time periods/demographics yourself. If data is not pre-aggregated, inform the user that aggregate data is not available. Always use the most appropriate administrative level that has pre-aggregated data.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **population_group**: Filter the response by the population group, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#population-group">here.</a>\n\n- **gender**: Filter the response by the gender, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#gender">here.</a>\n\n- **age_range**: Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data.\n\n- **min_age**: The minimum age from `age_range`, set to `null` if `age_range` is "all" and there is no age disaggregation\n\n- **max_age**: The maximum age from `age_range`, set to `null` if `age_range` is "all" and there is no age disaggregation, or if there is no upper limit to the age range\n\n- **origin_location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **origin_location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **origin_has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **origin_in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **asylum_location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **asylum_location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **asylum_has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **asylum_in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "resource_hdx_id": "string",\n "population_group": "REF",\n "gender": "f",\n "reference_period_start": "2024-01-01T12:00:00Z",\n "asylum_location_name": "string",\n "min_age": "unknown_type",\n "max_age": "unknown_type",\n "population": 1,\n "origin_location_code": "string",\n "reference_period_end": "unknown_type",\n "origin_location_name": "string",\n "asylum_location_code": "string",\n "age_range": "string"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'age_range': {'title': 'Age Range', 'description': 'Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data.', 'default': 'all', 'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}]}, 'asylum_has_hrp': {'title': 'Asylum Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'asylum_in_gho': {'title': 'Asylum In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'asylum_location_code': {'title': 'Asylum Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'asylum_location_name': {'title': 'Asylum Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'gender': {'title': 'Gender', 'description': 'Filter the response by the gender, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#gender">here.</a>', 'default': 'all', 'anyOf': [{'type': 'string', 'title': 'Gender', 'enum': ['f', 'm', 'x', 'u', 'o', 'all']}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'max_age': {'title': 'Max Age', 'description': 'The maximum age from `age_range`, set to `null` if `age_range` is "all" and there is no age disaggregation, or if there is no upper limit to the age range', 'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}]}, 'min_age': {'title': 'Min Age', 'description': 'The minimum age from `age_range`, set to `null` if `age_range` is "all" and there is no age disaggregation', 'anyOf': [{'type': 'integer', 'minimum': 0}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'origin_has_hrp': {'title': 'Origin Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'origin_in_gho': {'title': 'Origin In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'origin_location_code': {'title': 'Origin Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'origin_location_name': {'title': 'Origin Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'population_group': {'title': 'Population Group', 'description': 'Filter the response by the population group, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#population-group">here.</a>', 'anyOf': [{'type': 'string', 'title': 'PopulationGroup', 'enum': ['REF', 'ROC', 'ASY', 'OIP', 'IDP', 'IOC', 'STA', 'OOC', 'HST', 'RET', 'RST', 'NAT', 'RDP', 'RRI', 'all']}, {'type': 'null'}]}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'baseline_population_get', 'description': 'Baseline population data sourced and maintained by UNFPA (UN Population Fund). See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/population_and_socio-economy/#baseline-population">HDX HAPI documentation</a>, and the <a href="https://data.humdata.org/organization/unfpa">UNFPA on HDX</a>.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **gender**: Filter the response by the gender, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#gender">here.</a>\n\n- **age_range**: Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data.\n\n- **population_min**: Filter the response by a lower bound for the population.\n\n- **population_max**: Filter the response by a upper bound for the population.\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin_level**: Filter the response by admin level.\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "location_code": "string",\n "location_name": "string",\n "admin1_code": "unknown_type",\n "reference_period_start": "unknown_type",\n "gender": "f",\n "admin2_code": "unknown_type",\n "admin_level": 1,\n "min_age": "unknown_type",\n "admin2_name": "unknown_type",\n "max_age": "unknown_type",\n "population": 1,\n "admin1_name": "unknown_type",\n "reference_period_end": "unknown_type",\n "resource_hdx_id": "string",\n "age_range": "string"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'admin1_code': {'title': 'Admin1 Code', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin1_name': {'title': 'Admin1 Name', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin2_code': {'title': 'Admin2 Code', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin2_name': {'title': 'Admin2 Name', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin_level': {'title': 'Admin Level', 'description': 'Filter the response by admin level.', 'anyOf': [{'type': 'string', 'title': 'AdminLevel', 'enum': ['0', '1', '2']}, {'type': 'null'}]}, 'age_range': {'title': 'Age Range', 'description': 'Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data.', 'default': 'all', 'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'gender': {'title': 'Gender', 'description': 'Filter the response by the gender, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#gender">here.</a>', 'default': 'all', 'anyOf': [{'type': 'string', 'title': 'Gender', 'enum': ['f', 'm', 'x', 'u', 'o', 'all'], 'maxLength': 3}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'population_max': {'title': 'Population Max', 'description': 'Filter the response by a upper bound for the population.', 'anyOf': [{'type': 'integer'}, {'type': 'null'}]}, 'population_min': {'title': 'Population Min', 'description': 'Filter the response by a lower bound for the population.', 'anyOf': [{'type': 'integer'}, {'type': 'null'}]}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'climate_rainfall_get', 'description': 'Rainfall data . See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **aggregation_period**: Filter the response by the aggregation period, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#aggregation-period">here.</a>\n\n- **version**: Version rainfall\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin_level**: Filter the response by admin level.\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "location_code": "string",\n "location_name": "string",\n "admin1_code": "unknown_type",\n "reference_period_start": "unknown_type",\n "rainfall_long_term_average": 1.5,\n "rainfall_anomaly_pct": 1.5,\n "version": "unknown_type",\n "admin2_code": "unknown_type",\n "number_pixels": "unknown_type",\n "admin_level": 1,\n "admin2_name": "unknown_type",\n "rainfall": 1.5,\n "admin1_name": "unknown_type",\n "aggregation_period": "dekad",\n "reference_period_end": "unknown_type",\n "resource_hdx_id": "string",\n "provider_admin1_code": "unknown_type",\n "provider_admin2_code": "unknown_type"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'admin1_code': {'title': 'Admin1 Code', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin1_name': {'title': 'Admin1 Name', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin2_code': {'title': 'Admin2 Code', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin2_name': {'title': 'Admin2 Name', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin_level': {'title': 'Admin Level', 'description': 'Filter the response by admin level.', 'anyOf': [{'type': 'string', 'title': 'AdminLevel', 'enum': ['0', '1', '2']}, {'type': 'null'}]}, 'aggregation_period': {'title': 'Aggregation Period', 'description': 'Filter the response by the aggregation period, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#aggregation-period">here.</a>', 'anyOf': [{'type': 'string', 'title': 'AggregationPeriod', 'enum': ['dekad', '1-month', '3-month'], 'maxLength': 12}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'version': {'title': 'Version', 'description': 'Version rainfall', 'anyOf': [{'type': 'string', 'title': 'Version', 'enum': ['final', 'forecast', 'preliminary'], 'maxLength': 16}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'coordination_conflict_events_get', 'description': 'Armed Conflict Location & Events Data from ACLED. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/coordination_and_context/#conflict-events">HDX HAPI documentation</a>, and the <a href="https://acleddata.com/">original ACLED source</a> website.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **event_type**: Filter the response by the ACLED event-type categories (non-mutually exclusive), available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#event-type">here.</a>\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin_level**: Filter the response by admin level.\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "location_code": "string",\n "location_name": "string",\n "admin1_code": "unknown_type",\n "reference_period_start": "2024-01-01T12:00:00Z",\n "event_type": "civilian_targeting",\n "fatalities": "unknown_type",\n "admin2_code": "unknown_type",\n "events": "unknown_type",\n "admin_level": 1,\n "admin2_name": "unknown_type",\n "admin1_name": "unknown_type",\n "reference_period_end": "unknown_type",\n "resource_hdx_id": "string"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'admin1_code': {'title': 'Admin1 Code', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin1_name': {'title': 'Admin1 Name', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin2_code': {'title': 'Admin2 Code', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin2_name': {'title': 'Admin2 Name', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin_level': {'title': 'Admin Level', 'description': 'Filter the response by admin level.', 'anyOf': [{'type': 'string', 'title': 'AdminLevel', 'enum': ['0', '1', '2']}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'event_type': {'title': 'Event Type', 'description': 'Filter the response by the ACLED event-type categories (non-mutually exclusive), available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#event-type">here.</a>', 'anyOf': [{'type': 'string', 'title': 'EventType', 'enum': ['civilian_targeting', 'demonstration', 'political_violence']}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'coordination_funding_get', 'description': 'OCHA\'s funding data from the Financial Tracking Service provides information on humanitarian aid contributions. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/coordination_and_context/#funding">HDX HAPI documentation</a>, and the <a href="https://fts.unocha.org/home/2024/donors/view">original FTS source</a> website.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **appeal_code**: Filter the response by a unique code given by FTS to each appeal\n\n- **appeal_type**: Filter the respinse by the type of the appeal, such as flash or HRP\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "resource_hdx_id": "string",\n "appeal_code": "string",\n "appeal_name": "string",\n "reference_period_start": "2024-01-01T12:00:00Z",\n "location_code": "string",\n "appeal_type": "unknown_type",\n "requirements_usd": "unknown_type",\n "funding_pct": "unknown_type",\n "funding_usd": 1.5,\n "reference_period_end": "unknown_type",\n "location_name": "string"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'appeal_code': {'title': 'Appeal Code', 'description': 'Filter the response by a unique code given by FTS to each appeal', 'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}]}, 'appeal_type': {'title': 'Appeal Type', 'description': 'Filter the respinse by the type of the appeal, such as flash or HRP', 'anyOf': [{'type': 'string', 'maxLength': 64}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'coordination_national_risk_get', 'description': 'European Commission national risk data from the INFORM-risk framework. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/coordination_and_context/#national-risk">HDX HAPI documentation</a>, and the <a href="https://drmkc.jrc.ec.europa.eu/inform-index/INFORM-Risk">original INFORM-risk source</a> website.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **risk_class**: Filter the response by the INFORM risk class, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#risk-class">here.</a>\n\n- **global_rank_min**: Filter the response by a lower bound for the Global Rank.\n\n- **global_rank_max**: Filter the response by an upper bound for the Global Rank.\n\n- **overall_risk_min**: Filter the response by a lower bound for the Overall Risk.\n\n- **overall_risk_max**: Filter the response by an upper bound for the Overall Risk.\n\n- **hazard_exposure_risk_min**: Filter the response by a lower bound for the Hazard Exposure Risk.\n\n- **hazard_exposure_risk_max**: Filter the response by an upper bound for the Hazard Exposure Risk.\n\n- **vulnerability_risk_min**: Filter the response by a lower bound for the Vulnerability Risk.\n\n- **vulnerability_risk_max**: Filter the response by an upper bound for the Vulnerability Risk.\n\n- **coping_capacity_risk_min**: Filter the response by a lower bound for the Coping Capacity Risk.\n\n- **coping_capacity_risk_max**: Filter the response by a lower bound for the Coping Capacity Risk.\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "risk_class": "1",\n "global_rank": 1,\n "overall_risk": 1.5,\n "reference_period_start": "unknown_type",\n "vulnerability_risk": 1.5,\n "location_code": "string",\n "meta_missing_indicators_pct": "unknown_type",\n "reference_period_end": "unknown_type",\n "hazard_exposure_risk": 1.5,\n "resource_hdx_id": "string",\n "meta_avg_recentness_years": "unknown_type",\n "location_name": "string",\n "coping_capacity_risk": 1.5\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'coping_capacity_risk_max': {'title': 'Coping Capacity Risk Max', 'description': 'Filter the response by a lower bound for the Coping Capacity Risk.', 'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'coping_capacity_risk_min': {'title': 'Coping Capacity Risk Min', 'description': 'Filter the response by a lower bound for the Coping Capacity Risk.', 'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'global_rank_max': {'title': 'Global Rank Max', 'description': 'Filter the response by an upper bound for the Global Rank.', 'anyOf': [{'type': 'integer'}, {'type': 'null'}]}, 'global_rank_min': {'title': 'Global Rank Min', 'description': 'Filter the response by a lower bound for the Global Rank.', 'anyOf': [{'type': 'integer'}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'hazard_exposure_risk_max': {'title': 'Hazard Exposure Risk Max', 'description': 'Filter the response by an upper bound for the Hazard Exposure Risk.', 'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'hazard_exposure_risk_min': {'title': 'Hazard Exposure Risk Min', 'description': 'Filter the response by a lower bound for the Hazard Exposure Risk.', 'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'overall_risk_max': {'title': 'Overall Risk Max', 'description': 'Filter the response by an upper bound for the Overall Risk.', 'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'overall_risk_min': {'title': 'Overall Risk Min', 'description': 'Filter the response by a lower bound for the Overall Risk.', 'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'risk_class': {'title': 'Risk Class', 'description': 'Filter the response by the INFORM risk class, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#risk-class">here.</a>', 'anyOf': [{'type': 'string', 'title': 'RiskClass', 'enum': ['1', '2', '3', '4', '5']}, {'type': 'null'}]}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'vulnerability_risk_max': {'title': 'Vulnerability Risk Max', 'description': 'Filter the response by an upper bound for the Vulnerability Risk.', 'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'vulnerability_risk_min': {'title': 'Vulnerability Risk Min', 'description': 'Filter the response by a lower bound for the Vulnerability Risk.', 'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'coordination_operational_presence_get', 'description': 'OCHA\'s 3W (Who is doing What Where) Operational Presence data provides information about which organizations are working in different locations affected by a crisis. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/coordination_and_context/#who-is-doing-what-where-operational-presence">HDX HAPI documentation</a>, and the <a href="https://3w.unocha.org/">original OCHA 3W source</a> website.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **sector_code**: Filter the response by sector codes, which describe the humanitarian sector to which the operational presence applies. Use the metadata_sector_get tool to get available sector codes and names.\n\n- **sector_name**: Filter the response by sector names, which describe the humanitarian sector to which the operational presence applies. Use the metadata_sector_get tool to get available sector codes and names.\n\n- **org_acronym**: Filter the response by the acronym of the organization to which the operational presence applies. Use the metadata_org_get tool to get available organization codes and names.\n\n- **org_name**: Filter the response by the name of the organization to which the operational presence applies. Use the metadata_org_get tool to get available organization codes and names.\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin_level**: Filter the response by admin level.\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "location_code": "string",\n "location_name": "string",\n "admin1_code": "unknown_type",\n "reference_period_start": "2024-01-01T12:00:00Z",\n "sector_name": "string",\n "org_type_description": "unknown_type",\n "admin2_code": "unknown_type",\n "admin_level": 1,\n "admin2_name": "unknown_type",\n "org_type_code": "unknown_type",\n "admin1_name": "unknown_type",\n "reference_period_end": "unknown_type",\n "org_acronym": "string",\n "org_name": "string",\n "sector_code": "string",\n "resource_hdx_id": "string"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'admin1_code': {'title': 'Admin1 Code', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin1_name': {'title': 'Admin1 Name', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin2_code': {'title': 'Admin2 Code', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin2_name': {'title': 'Admin2 Name', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin_level': {'title': 'Admin Level', 'description': 'Filter the response by admin level.', 'anyOf': [{'type': 'string', 'title': 'AdminLevel', 'enum': ['0', '1', '2']}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'org_acronym': {'title': 'Org Acronym', 'description': 'Filter the response by the acronym of the organization to which the operational presence applies. Use the metadata_org_get tool to get available organization codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}]}, 'org_name': {'title': 'Org Name', 'description': 'Filter the response by the name of the organization to which the operational presence applies. Use the metadata_org_get tool to get available organization codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'sector_code': {'title': 'Sector Code', 'description': 'Filter the response by sector codes, which describe the humanitarian sector to which the operational presence applies. Use the metadata_sector_get tool to get available sector codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'sector_name': {'title': 'Sector Name', 'description': 'Filter the response by sector names, which describe the humanitarian sector to which the operational presence applies. Use the metadata_sector_get tool to get available sector codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'food_prices_get', 'description': 'The World Food Programme (WFP) food prices data provides information about food prices for a range of commodities at markets across the world. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/food_security_and_nutrition/#food-prices">HDX HAPI documentation</a>, and the <a href="https://dataviz.vam.wfp.org/economic/prices">original WFP source</a> website.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **market_code**: Filter the response by the unique code identifying the market\n\n- **market_name**: Filter the response by the name of the market\n\n- **commodity_code**: Filter the response by the unique code identifying the commodity\n\n- **commodity_category**: Filter the response by the food group that the commodity belongs to, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#commodity-category">here.</a>\n\n- **commodity_name**: Filter the response by the name of the commodity\n\n- **price_flag**: Filter the response by the pre-processing characteristics of food prices, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#price-flag">here.</a>\n\n- **price_type**: Filter the response by the point in the supply chain at which the price is determined, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#price-type">here.</a>\n\n- **price_min**: Filter the response by a lower bound for the price.\n\n- **price_max**: Filter the response by a upper bound for the price.\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin_level**: Filter the response by admin level.\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "location_code": "string",\n "location_name": "string",\n "admin1_code": "unknown_type",\n "admin2_code": "unknown_type",\n "currency_code": "string",\n "price": 1.5,\n "reference_period_end": "unknown_type",\n "market_name": "string",\n "commodity_name": "string",\n "market_code": "string",\n "price_flag": "actual",\n "price_type": "Farm Gate",\n "admin1_name": "unknown_type",\n "unit": "string",\n "commodity_code": "string",\n "reference_period_start": "2024-01-01T12:00:00Z",\n "commodity_category": "cereals and tubers",\n "lon": "unknown_type",\n "admin_level": 1,\n "admin2_name": "unknown_type",\n "lat": "unknown_type",\n "resource_hdx_id": "string"\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'admin1_code': {'title': 'Admin1 Code', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin1_name': {'title': 'Admin1 Name', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin2_code': {'title': 'Admin2 Code', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin2_name': {'title': 'Admin2 Name', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin_level': {'title': 'Admin Level', 'description': 'Filter the response by admin level.', 'anyOf': [{'type': 'string', 'title': 'AdminLevel', 'enum': ['0', '1', '2']}, {'type': 'null'}]}, 'commodity_category': {'title': 'Commodity Category', 'description': 'Filter the response by the food group that the commodity belongs to, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#commodity-category">here.</a>', 'anyOf': [{'type': 'string', 'title': 'CommodityCategory', 'enum': ['cereals and tubers', 'meat, fish and eggs', 'milk and dairy', 'miscellaneous food', 'non-food', 'oil and fats', 'pulses and nuts', 'vegetables and fruits']}, {'type': 'null'}]}, 'commodity_code': {'title': 'Commodity Code', 'description': 'Filter the response by the unique code identifying the commodity', 'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}]}, 'commodity_name': {'title': 'Commodity Name', 'description': 'Filter the response by the name of the commodity', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'market_code': {'title': 'Market Code', 'description': 'Filter the response by the unique code identifying the market', 'anyOf': [{'type': 'string', 'maxLength': 32}, {'type': 'null'}]}, 'market_name': {'title': 'Market Name', 'description': 'Filter the response by the name of the market', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'price_flag': {'title': 'Price Flag', 'description': 'Filter the response by the pre-processing characteristics of food prices, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#price-flag">here.</a>', 'anyOf': [{'type': 'string', 'title': 'PriceFlag', 'enum': ['actual', 'aggregate', 'actual,aggregate']}, {'type': 'null'}]}, 'price_max': {'title': 'Price Max', 'description': 'Filter the response by a upper bound for the price.', 'anyOf': [{'type': 'number'}, {'type': 'string'}, {'type': 'null'}]}, 'price_min': {'title': 'Price Min', 'description': 'Filter the response by a lower bound for the price.', 'anyOf': [{'type': 'number'}, {'type': 'string'}, {'type': 'null'}]}, 'price_type': {'title': 'Price Type', 'description': 'Filter the response by the point in the supply chain at which the price is determined, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#price-type">here.</a>', 'anyOf': [{'type': 'string', 'title': 'PriceType', 'enum': ['Farm Gate', 'Producer', 'Retail', 'Wholesale']}, {'type': 'null'}]}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'food_security_get', 'description': 'Integrated Food Security Phase Classification from the IPC. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/food_security_and_nutrition/#food-security">HDX HAPI documentation</a>, and the <a href="https://www.ipcinfo.org/ipcinfo-website/ipc-overview-and-classification-system/ipc-acute-food-insecurity-classification/en/">original IPC source</a> website.\n\n\n**Query Parameters:**\n\n- **app_identifier** (Required): base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.\n\n- **ipc_phase**: Filter the response by the IPC phase, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#ipc-code">here.</a>\n\n- **ipc_type**: Filter the response by the IPC type, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#ipc-type">here.</a>\n\n- **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.\n\n- **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.\n\n- **start_date**: Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00\n\n- **end_date**: Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59\n\n- **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.\n\n- **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.\n\n- **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.\n\n- **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.\n\n- **admin_level**: Filter the response by admin level.\n\n- **output_format**: No description.\n\n- **limit**: Maximum number of records to return. The system will not return more than 10,000 records.\n\n- **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.\n\n\n**Responses:**\n\n- **200** (Success): Successful Response\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "data": [\n {\n "location_code": "string",\n "location_name": "string",\n "admin1_code": "unknown_type",\n "reference_period_start": "unknown_type",\n "ipc_phase": "string",\n "population_fraction_in_phase": 1.5,\n "admin2_code": "unknown_type",\n "ipc_type": "string",\n "admin_level": 1,\n "admin2_name": "unknown_type",\n "admin1_name": "unknown_type",\n "reference_period_end": "unknown_type",\n "resource_hdx_id": "string",\n "population_in_phase": 1\n }\n ]\n}\n```\n\n- **400**: Bad Request\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": "string"\n}\n```\n\n- **422**: Validation Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "detail": [\n {\n "loc": [\n "unknown_type"\n ],\n "msg": "string",\n "type": "string"\n }\n ]\n}\n```\n\n- **500**: Internal Server Error\n - Content-Type: `application/json`\n\n - **Response Properties:**\n\n - **Example:**\n```json\n{\n "error_sample_list": [\n "unknown"\n ],\n "error": "string"\n}\n```', 'parameters': {'type': 'object', 'properties': {'admin1_code': {'title': 'Admin1 Code', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin1_name': {'title': 'Admin1 Name', 'description': 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin2_code': {'title': 'Admin2 Code', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'admin2_name': {'title': 'Admin2 Name', 'description': 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'admin_level': {'title': 'Admin Level', 'description': 'Filter the response by admin level.', 'anyOf': [{'type': 'string', 'title': 'AdminLevel', 'enum': ['0', '1', '2']}, {'type': 'null'}]}, 'end_date': {'title': 'End Date', 'description': 'Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'has_hrp': {'title': 'Has Hrp', 'description': 'Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'in_gho': {'title': 'In Gho', 'description': 'Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.', 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'ipc_phase': {'title': 'Ipc Phase', 'description': 'Filter the response by the IPC phase, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#ipc-code">here.</a>', 'anyOf': [{'type': 'string', 'title': 'IPCPhase', 'enum': ['1', '2', '3', '4', '5', '3+', 'all']}, {'type': 'null'}]}, 'ipc_type': {'title': 'Ipc Type', 'description': 'Filter the response by the IPC type, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#ipc-type">here.</a>', 'anyOf': [{'type': 'string', 'title': 'IPCType', 'enum': ['current', 'first projection', 'second projection']}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum number of records to return. The system will not return more than 10,000 records.', 'default': 10, 'minimum': 0, 'maximum': 10000}, 'location_code': {'title': 'Location Code', 'description': 'Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 128}, {'type': 'null'}]}, 'location_name': {'title': 'Location Name', 'description': 'Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names.', 'anyOf': [{'type': 'string', 'maxLength': 512}, {'type': 'null'}]}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.', 'default': 0, 'minimum': 0}, 'output_format': {'type': 'string', 'title': 'OutputFormat', 'default': 'json', 'enum': ['csv', 'json']}, 'start_date': {'title': 'Start Date', 'description': 'Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00', 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'hdx_get_dataset_info', 'description': 'Get detailed information about a specific HDX dataset.\n\nArgs:\n dataset_hdx_id: The HDX dataset identifier\n\nReturns:\n Dictionary containing dataset information', 'parameters': {'type': 'object', 'properties': {'dataset_hdx_id': {'type': 'string', 'title': 'Dataset Hdx Id'}}, 'required': ['dataset_hdx_id'], 'additionalProperties': False}, 'strict': True}
|
hdx
|
other
|
{'type': 'function', 'name': 'hdx_search_locations', 'description': 'Search for locations (countries) in the HDX system.\n\nArgs:\n name_pattern: Optional pattern to match location names\n has_hrp: Optional filter for locations with Humanitarian Response Plans\n\nReturns:\n Dictionary containing matching locations', 'parameters': {'type': 'object', 'properties': {'has_hrp': {'title': 'Has Hrp', 'default': None, 'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'name_pattern': {'title': 'Name Pattern', 'default': None, 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.