> For the complete documentation index, see [llms.txt](https://docs.premium-positioning.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.premium-positioning.com/rinexlab/api.md).

# Rinexlab API

The Rinexlab REST API: create a key, make a first call, order virtual RINEX, run PPP and differential jobs, poll operations and download results. Production and integration environments.

The Rinexlab API gives your software the same processing engine as the web application: virtual RINEX orders, PPP and differential processing, file upload and download, base coordinates, job status and results, and your credit balance.

The full reference is an OpenAPI 3.1 document: [hub.rinexlab.com/api/v1/openapi.json](https://hub.rinexlab.com/api/v1/openapi.json). The **Developers** page of the application also has an interactive reference.

{% embed url="<https://www.youtube.com/watch?v=RG-tSK_FtU4>" %}
Create an API key and make a first call (video, about 80 s)
{% endembed %}

### Create a key

1. Open **Developers** from the menu and click **New API key**.
2. Give the key a name and choose its environment.
3. Copy the key: for security, it is shown only once and stored only as a hash. A lost key cannot be recovered: revoke it and create a new one.

| Environment | Key prefix  | What it does                                                                          |
| ----------- | ----------- | ------------------------------------------------------------------------------------- |
| Production  | `rxl_live_` | Spends your credits and delivers real files and results                               |
| Integration | `rxl_test_` | Free and simulated, issued to integrators on request (**Ask for integration access**) |

Integration keys run the real contract, job states, result format and error codes of production, but nothing is computed:

* a virtual RINEX returns a fixed test file, with the real navigation files of the requested days;
* a PPP or differential job returns a result at a fixed test position (46.75 N, 5.75 E).

Integration use is capped each month, in credits-equivalent across all services. Beyond the cap the API returns `429 integration_cap`.

### First call

The **Quick start** on the Developers page gives a first call in curl, JavaScript and Python. A typical flow:

1. `POST /vrs` orders a virtual RINEX. The response returns an operation id, the credits and the status `queued`.
2. `GET /operations/{id}` gives the status of the operation. Poll it until it is done.
3. Download the file, and list its navigation files with `GET /files/{id}/navigation`.

### Main endpoints

| Endpoint                                        | Purpose                                                                                   |
| ----------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `POST /vrs`                                     | Order a virtual RINEX                                                                     |
| `POST /ppp`                                     | Start a PPP job                                                                           |
| `POST /differential`                            | Start a differential job, up to 10 bases                                                  |
| `GET /coverage`                                 | Check virtual RINEX coverage at a point and date                                          |
| `GET /operations`, `GET /operations/{id}`       | List your jobs, or the status and result of one                                           |
| `POST /files`, then `POST /files/{id}/complete` | Upload a file: the first call returns an upload URL, the second starts the pre-processing |
| `GET /files`, `GET /files/{id}`                 | List your files, or the details of one, including its constellations                      |
| `PATCH /files/{id}`                             | Set the reference coordinates of a base                                                   |
| `GET /files/{id}/download`                      | Download an observation file                                                              |
| `GET /files/{id}/navigation`                    | List the navigation files of a virtual RINEX                                              |
| `DELETE /files/{id}`                            | Delete a file                                                                             |
| `GET /me`                                       | Your account and credit balance                                                           |

The OpenAPI document lists every endpoint, parameter and status code.

### Good to know

* **Dry run.** `dry_run: true` on `POST /ppp` and `POST /differential` returns the credits without creating the job.
* **Base coordinates.** A differential base needs reference coordinates: `PATCH /files/{id}` with `{ "reference": { "lat", "lon", "height", "datum" } }`. Without them, the job returns `409 base_no_reference`.
* **Results.** The result files of a PPP or differential job are listed in `result.files` of `GET /operations/{id}`, each with its download path. `/operations/{id}/files.zip` returns them all.
* **Virtual RINEX.** The job gives its observation file in `result.file_id` and its navigation files in `result.navigation`. `GET /files/{id}/navigation/{name}` returns a download link valid 2 minutes.
* **Coordinate format.** Result downloads accept `format=dd`, `dms`, `utm` or `ecef`: the positions CSV and `summary.json` are converted, the other files stay as computed.
* **File extension.** `GET /files/{id}/download?ext=rnx` or `?ext=obs` returns the same plain observation file named `.rnx` or `.obs`.
* **Combined trajectories.** Kinematic differential jobs with two bases or more, and kinematic PPP with two product pairs or more, carry `result.combined` and a `positions_combined_...csv` file.
* **Coverage quality.** `GET /coverage` and `POST /vrs` return `quality` (`favourable`, `good` or `limited`), the same indicative level as the order form. `GET /coverage` also returns `inside_network`.

### Common errors

| Status                  | Meaning                                            |
| ----------------------- | -------------------------------------------------- |
| `400 too_many_bases`    | More than 10 bases in a differential job           |
| `402`                   | Not enough credits                                 |
| `409 no_coverage`       | No virtual RINEX coverage at that point and date   |
| `409 base_no_reference` | A base has no reference coordinates                |
| `429 integration_cap`   | Monthly cap of the integration environment reached |

### Integrators

Software companies that embed Rinexlab in their products have a dedicated contract with volume rates, contractual availability and support terms. Contact <info@premium-positioning.com>.

Last updated: 28 October 2026
