# Scrap

Una herramienta para obtener informacion de viviendas usando la API the finca
raiz

## CLI
```shell
Usage:
    scrap [options] <city>

Options:
    -h  --help      Show this message
    -v  --verbose   Be more verbose
    -o FILE         Redirect standard output to FILE.
    -p INT          Number of pages to get [default: 1]

Examples:
    $ scrap Medellín -p 20
```

## Libreria
```python
get_json(city: str, pages: int = 1) -> list:
    """Get json data from fincaraiz.com.co
        
        Parameters
        ----------
        city : str
            City to search houses
        pages : int
            Pages to download, each page has 100 offers.

        Returns
        -------
        list[dict]:
            json file with house results

    """

>>> from scrap.fincaraiz import get_json
>>> data = get_json('Bogota, d.c')
```