Documentation
Huit lignes jusqu’au premier événement, puis plus de réécriture.
Une enveloppe couvre chaque type d’événement et chaque livre. Obtenez une clé, prenez un abonnement à un sujet, filtrez sur le verdict. C’est toute l’intégration.
Pointez votre agent ici
Votre agent peut lire cette documentation lui même.
Donnez l’un de ces fichiers à un modèle ou à un script et il a ce qu’il faut pour consommer le flux correctement, sans qu’une personne transcrive cette page en code.
/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. | Fichier | À 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 fichier est servi depuis ce site et ne demande aucune clé. Les spécifications et les exemples sont générés depuis la même source que cette page.
Démarrage rapide
De rien à un événement en direct.
L’offre gratuite est en temps réel, donc vous construisez contre les mêmes événements qu’un abonné payant reçoit, plutôt que contre un bac à sable qui se comporte autrement.
- 1
Obtenez une clé npayload
Wickfeed est un flux sur npayload. Créez une clé, puis prenez un abonnement au sujet wickfeed. Il n’y a pas de compte Wickfeed séparé à gérer.
- 2
Prenez un abonnement à un sujet
wickfeed.lit pour le verdict, ou wickfeed.* pour les quatre types d’événements. 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 reaction égal à sous réaction. Trois conditions et c’est fini.
- 4
Relisez quand vous avez besoin d’historique
Demandez un décalage à npayload et relisez la fenêtre. Les fenêtres sont ordonnées sur l’horloge de la source, donc 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
Les champs que lit votre gestionnaire.
Les quatre types d’événements partagent cette forme. moved, mouth et print omettent l’objet verdict. Seul lit le porte. Le schéma JSON publié porte la liste complète des champs.
Identité
type | chaîne | wickfeed.<type>.v<n> |
wick_id | chaîne | wick_ suivi de 26 caractères hexadécimaux, dérivé du contrat, de la fenêtre et de la cause. Stable en cas de redistribution, donc un doublon peut être ignoré sans risque. |
prev_wick_id | chaîne | null | Le wick précédent pour cet identifiant, formant une chaîne par contrat. Null exactement une fois, en tête de chaîne. |
id | chaîne | L’identifiant canonique wf:. |
book | chaîne | Le livre du registre. En service aujourd’hui : midterms et fed. De nouveaux livres sont ajoutés sans changement de version. |
venue | chaîne | D’où provient cette observation. |
venue_ref | chaîne | null | L’identifiant propre de la place pour ce contrat. Null tant qu’il n’a pas été résolu face aux données réelles de cette place. |
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é au delà de la borne de retard. Il ne réécrit jamais un wick déjà publié. |
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 en vigueur pour ce contrat au déclenchement, dérivé de sa propre volatilité réalisée. |
Verdict (lit uniquement)
verdict.driver | énum | information, liquidity, unknown. Unknown sous une attribution de 0,30. |
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 | Confiance du juge dans le verdict. Un lit n’est publié qu’au seuil de publication ou au dessus, seuil fixé à 0,70 au départ. |
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. |
cause.relevance | entier | 0 à 100. Sous 70, un candidat ne peut pas allumer une mèche. |
cause.novelty | entier | 0 à 100. La première mention d’un fait dans une fenêtre de 24 heures 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, sur les seules horloges des sources. 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 un consommateur doit tolérer ce qu’il ne reconnaît pas.
Votre agent voit le prix bouger. Vous lui envoyez la raison.
L’abonnement se prend avec une clé npayload. L’offre gratuite est en temps réel, plafonnée à cinq événements par heure, et huit lignes de code impriment votre premier événement.
Sans carte. Sans connexion. Sans tableau de bord.