1dex Connector Tester l'API

JavaScript · Python · CLI

Clients API pour 1dex.

Clients JavaScript, Python et CLI pour appeler l'API publique. Les contrats API, l'OpenAPI, les quotas et la documentation métier restent maintenus sur 1dex.fr.

npm i -g @1dex-fr/1dex
1dex "10 rue des cordeliers aix"
1dex score address "10 rue des cordeliers aix"

Racine API. https://1dex.fr/api/v1

OpenAPI. https://1dex.fr/api/v1/openapi.yaml

Swagger. https://1dex.fr/api/v1/docs

Démarrage

Lire, débloquer et scorer une adresse.

Le connecteur expose des helpers pour les routes publiques documentées sur 1dex.fr, dont les détails, déblocages et quotas réservés aux comptes professionnels abonnés.

npm

npm i -g @1dex-fr/1dex
1dex overview "10 rue des cordeliers aix" --dvf-radius-m 300
1dex details "10 rue des cordeliers aix" --fields summary,rail --api-key "$ONEDEX_API_KEY"
1dex score address "10 rue des cordeliers aix" -f summary

curl

curl -sS "https://1dex.fr/api/v1/address-overview?address=10%20rue%20des%20cordeliers%20aix&dvf_radius_m=600"
curl -sS "https://1dex.fr/api/v1/address-details?address=10%20rue%20des%20cordeliers%20aix&fields=summary,rail" \
  -H "Authorization: Bearer $ONEDEX_API_KEY"
curl -sS -X POST "https://1dex.fr/api/v1/score/address" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"address":"10 rue des cordeliers aix"}]}'

JavaScript

npm i @1dex-fr/connector

import { OneDexClient } from "@1dex-fr/connector";

const client = new OneDexClient({
  apiKey: process.env.ONEDEX_API_KEY,
});
const suggestions = await client.autocomplete.address({
  q: "10 rue des cordeliers aix",
  limit: 5,
});
const score = await client.score.address({
  items: [{ address: "10 rue des cordeliers aix" }],
});
const details = await client.address.details({
  address: "10 rue des cordeliers aix",
  fields: ["summary", "rail"],
});
const usage = await client.account.usage();

console.log(suggestions.suggestions, score.items, details.fields, usage.credits.total_remaining);

Python

python -m pip install 1dex-connector

import os

from onedex import OneDexClient

client = OneDexClient(api_key=os.getenv("ONEDEX_API_KEY"))
suggestions = client.autocomplete.address({
    "q": "10 rue des cordeliers aix",
    "limit": 5,
})
score = client.score.address({
    "items": [{"address": "10 rue des cordeliers aix"}],
})
details = client.address.details({
    "address": "10 rue des cordeliers aix",
    "fields": ["summary", "rail"],
})
usage = client.account.usage()

print(suggestions["suggestions"], score["items"], details["fields"], usage["credits"]["total_remaining"])

Documentation officielle

Documentation API.

La documentation interactive est rendue sur une page dédiée depuis https://1dex.fr/api/v1/openapi.yaml.

Packages

Clients et exemples.

JavaScript. Client sans dépendance runtime dans packages/js.

Python. Client standard library dans packages/python.

CLI. Commandes de smoke test et export JSON/CSV dans cli.

Compatibilité. Les anciens liens locaux de documentation renvoient vers les pages officielles de 1dex.fr.

Contrat vivant

Console, documentation API et clients.