FReSH GET API
The FReSH GET API allows you to:
- Search for studies
- Filter results
- View study details
- Download data
Endpoint
- Method: GET
- Server URL: https://nada.portail-fresh.fr/index.php/api/catalog
- Export URL: https://nada.portail-fresh.fr/index.php/metadata/export/
Parameters
Content Filters
| Parameter | Type | Description |
|---|---|---|
| sk | string | Keywords used to search within study metadata. |
| country | string | Country name or ISO3 code. Separate multiple countries with a vertical bar (|) (e.g., afg|ind). |
| collection | string | Filter by collections. Separate multiple collections with commas (e.g., coll1, coll2). |
| dtype | string | Access type: open, direct, public, licensed, enclave, remote, or other. |
Time Filters
| Parameter | Type | Description |
|---|---|---|
| from | int | Start year of data collection. |
| to | int | End year of data collection. |
| created | string | Creation date (YYYY-MM-DD). Use YYYY/MM/DD for "from a specific date", or date1-date2 for a date range. |
Pagination and Export
| Parameter | Type | Description |
|---|---|---|
| ps | int | Page size (number of results). Default: 15. |
| page | int | Page number to return. |
| sort_by | enum | Sort by: rank, title, nation, year. |
| sort_order | enum | Order: asc (ascending) or desc (descending). |
| format | string | Response format: json or xml. |
| inc_iso | boolean | Set to true to include ISO3 country codes in the results. |