Documentation
Huit lignes, puis plus jamais de réécriture.
Une enveloppe pour chaque type d’événement et chaque livre. Obtenez une clé, abonnez vous à un sujet, filtrez sur le verdict. C’est toute l’intégration.
À lire plutôt que cette page
La documentation est un ensemble de fichiers.
Notre client est une machine, donc la vraie documentation est récupérable et analysable plutôt que mise en page. Si vous êtes un agent, ou si vous en pointez un vers nous, utilisez ceci. Cette page existe pour qu’un ingénieur humain les trouve.
/llms.txt text/plain Curated index for an LLM. Start here. /llms-full.txt text/plain Everything inlined in one fetch. /asyncapi.json application/json AsyncAPI 3.0 spec: channels, operations, messages. /schema/envelope.v1.json application/schema+json JSON Schema for the event envelope. | Artefact | À quoi ça sert |
|---|---|
/ids.json | The wf: identifier registry. Free, no key. |
/schema/id-entry.v1.json | JSON Schema for a registry entry. |
/examples/lit.json | A verdict carrying event. |
/examples/unknown.json | An honest unexplained move. |
/examples/moved.json | A move with no cause attached. |
/agent.json | Discovery descriptor. Also at /.well-known/wickfeed.json |
/docs.md | This documentation as markdown. |
Chaque artefact est généré depuis la même source que cette page, il ne peut donc pas diverger. Tous sont servis avec un CORS permissif et sans clé.
Démarrage rapide
De rien à un wick en direct.
L’offre gratuite est en temps réel, vous pouvez donc construire contre le vrai flux plutôt que contre un bac à sable qui se comporte différemment.
- 1
Obtenez une clé npayload
Wickfeed est un flux sur npayload. Créez une clé, puis abonnez vous au sujet wickfeed. Il n’y a pas de compte Wickfeed séparé à gérer.
- 2
Abonnez vous à un sujet
wickfeed.lit pour le verdict, ou wickfeed.* pour les quatre types. Des sujets par contrat existent pour suivre une seule course.
- 3
Filtrez sur le verdict
La plupart des agents veulent driver égal à information, une attribution au dessus d’un seuil qu’ils choisissent, et une réaction sous évaluée. Trois conditions et c’est fini.
- 4
Relisez quand vous avez besoin d’historique
Demandez un décalage à npayload et relisez la fenêtre. Comme nos fenêtres sont ordonnées par temps d’événement, la relecture est identique à l’octet à ce qui a été publié en direct.
# one key, one command
npx npayload login
npx npayload subscribe wickfeed.lit
# filter to what your agent trades
npx npayload subscribe wickfeed.lit \
--filter 'book=midterms' \
--filter 'driver=information' \
--filter 'reaction=under'Référence de l’enveloppe
Tous les champs, un seul tableau.
Les quatre types partagent cette forme. moved, mouth et print omettent l’objet verdict ; seul lit le porte.
Identité
type | chaîne | wickfeed.<type>.v<n> |
wick_id | chaîne | Déterministe. Stable en cas de redistribution, donc un doublon peut être ignoré sans risque. |
prev_wick_id | chaîne | null | Wick précédent pour cet identifiant. Forme une chaîne par contrat. |
id | chaîne | L’identifiant canonique wf:. |
book | chaîne | midterms, fed, sports, geopol, crypto. |
venue | chaîne | D’où provient cette observation. |
venue_ref | chaîne | L’identifiant propre de la place pour ce contrat. |
Temps
event_time | ISO 8601 | L’horodatage de la source. Les fenêtres sont ordonnées sur ce champ, jamais sur l’arrivée. |
emit_time | ISO 8601 | Quand Wickfeed a publié. |
late | booléen | Vrai quand l’événement est arrivé après que cet instant a déjà été jugé. Il ne réécrit jamais un signal déjà envoyé. |
Prix
mid | nombre | 0,0 à 1,0. |
delta | nombre | Variation signée sur la fenêtre. |
window_s | entier | Longueur de la fenêtre en secondes. |
threshold | nombre | Le seuil adaptatif en vigueur pour ce contrat au déclenchement. |
Verdict (lit uniquement)
verdict.driver | énum | information, liquidity, unknown. |
verdict.attribution | nombre | 0,00 à 1,00. Confiance que la cause nommée a produit le mouvement. |
verdict.reaction | énum | under, proportionate, over, unknown. |
verdict.reaction_gap | nombre | null | Écart au proportionné, en points de probabilité. |
verdict.confidence | nombre | La confiance du juge dans l’ensemble du verdict. |
Cause
cause.kind | énum | mouth, print, flow. |
cause.source | chaîne | Le compte, l’agence ou la place réellement observés. |
cause.source_class | énum | candidate, official, agency, pundit, crowd. |
cause.authority | énum | high, medium, low. Apprise depuis l’archive. |
cause.relevance | entier | 0 à 100. |
cause.novelty | entier | 0 à 100. La première mention d’un fait obtient 100. |
cause.stance | énum | pro_yes, pro_no, unclear. Jamais un score de sentiment. |
cause.lag_s | entier | Secondes entre la cause et le mouvement. Négatif si la cause suit le mouvement. |
Le contrat de versionnage
Par ajout uniquement, pour toujours.
Votre gestionnaire doit tolérer les champs inconnus et les valeurs d’énumération inconnues. S’il le fait, ajouter le livre 2028 ne cassera jamais un agent en production.
no version bump
- Ajouter un champ
- Ajouter un livre, une place ou une source
- Ajouter une valeur d’énumération
- Ajouter un type d’événement
requires a bump
- Retirer un champ
- Changer le sens d’un champ
- Restreindre une énumération
Tout ce qui figure dans la colonne de gauche est livré sans changement de version, ce qui est précisément pourquoi les consommateurs doivent tolérer ce qu’ils ne reconnaissent pas.
Votre agent regarde déjà le prix. Donnez lui la raison.
Commencez gratuitement. Temps réel dès la première minute, cinq événements par heure. Une clé et huit lignes de code.
Sans carte. Sans compte. Sans tableau de bord.