> For the complete documentation index, see [llms.txt](https://mdevst.gitbook.io/weatherfinder/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mdevst.gitbook.io/weatherfinder/introduction.md).

# Introduction

weatherFinder is an npm module that allows you to obtain weather data of all cities in the world.

<div align="center" data-full-width="false"><figure><img src="https://2643917806-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3GtWIv3Lv3RxZcZmYfuz%2Fuploads%2FpgtFJeCik5TfBIo4itfL%2FBa%C5%9Fl%C4%B1k.png?alt=media&amp;token=c2ca1bcf-7001-4cd3-bab7-c77ac99d6e16" alt=""><figcaption></figcaption></figure></div>

* [x] ES6 and CommonJS Support
* [x] TypeScript Support
* [x] Detailed Error Messages
* [x] Advanced and New

All weather data is provided by the Finnish Meteorological Institute.

{% embed url="<https://en.ilmatieteenlaitos.fi/>" fullWidth="false" %}

If you are curious about anything related to API data, you can take a look here:&#x20;

{% content-ref url="/pages/utBOhSa3tnW7g1awImhi" %}
[FAQ](/weatherfinder/faq.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://mdevst.gitbook.io/weatherfinder/introduction.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.