XML API de BullionVault

Résumé

Le système de BullionVault a deux interfaces: l'interface GUI normale pour les utilisateurs et l'interface XML pour les robots informatiques "traders". L'interface XML n'est pas considérée comme un service "primaire" de BullionVault mais peut être utilisé pour simplifier le développement des robots informatiques. Ce document décrit l'interface XML, procurant à un développeur de robots informatiques suffisamment d'informations pour se lancer. Il ne s'agit pas d'un guide complet et nous ne donnons aucune information sur les stratégies d'achat ou de vente.

Pour qui ?

De document est destiné aux programmeurs / développeurs. Le lecteur doit être familier avec les protocoles de demande/réponse et avec les formats de fichiers XML.

Avertissement

L'interface XML est fournit sans garanties ni support. BullionVault utilise cette interface et a donc tout intérêt à ce qu'elle soit stable et fiable. Cependant, BullionVault ne garantit aucunement la stabilité de l'interface, ni l'exactitude des informations qu'elle procure.

Acheter et vendre comme un "trader" implique des risques de pertes financières. L'automatisation de cette activité implique des risques supplémentaires (exactitude des informations, fiabilité des connexions, vitesse du système de réponse etc.). En utilisant XML API vous acceptez tous les risques encourus incluant (mais non limités à) le risque financier quelle qu'en soit la raison.

BullionVault se réserve le droit de facturer ou de suspendre les clients dont les robots enfreignent les Conditions d'utilisation — par exemple en utilisant des ressources système excessives. Veuillez interroger le système dans des limites raisonnables.

Vue d'ensemble

L'API BullionVault opère comme le site GUI normal. Les paramètres CGI sont traités et la réponse est renvoyée du serveur. La principale différence est que la réponse est XML plutôt que HTML. Ainsi, il est relativement facile pour un programmeur qualifié d'interfacer avec le système et d'acheter ou de vendre de façon automatique. Toutes les pages GUI qui sont nécessaires à l'achat ou à la vente (par exemple la page d'affichage des marchés) ont des équivalents XML. Presque toutes les pages auxiliaires non nécessaires au trading (par exemple les relevés et la page de réglages) n'ont pas d'équivalent XML et doivent être configurées manuellement.

Sécurité

Veuillez noter que nos serveurs web utilisent un cookie de session pour suivre votre session de connexion (JSESSIONID). Votre robot doit gérer les cookies de la même manière qu’un navigateur classique, sans quoi votre connexion sera constamment oubliée.

Lors de la première requête vers une page sécurisée via un client HTTPS, l’utilisateur ou le robot est temporairement redirigé vers un écran de connexion (nom d’utilisateur/mot de passe) à:

https://or.bullionvault.fr/secure/login.do

Les paramètres CGI de cet écran j_username j_password sont soumis à :

https://or.bullionvault.fr/secure/j_security_check?j_username=XXX&j_password=YYY

En cas de succès, l’utilisateur est alors connecté.

Requêtes XML API

XML API fournit huit services différents à l'heure actuelle :

• Consulter le marché
• Passer un ordre
• Annuler un ordre
• Consulter les soldes
• Suivre les ordres
• Suivre un ordre en particulier
• Configuration de l’unité de poids
• Actualisation de la configuration de l’unité de poids

Consulter le marché

URL : https://or.bullionvault.fr/view_market_xml.do

Voici le lien pour le " view market API " https://live.bullionvault.com/secure/api/v2/view_market_xml.do (vous devez vous connecter pour ce faire). La version non connectée http://live.bullionvault.com/view_market_xml.do est en cache sur le serveur et n’est pas autant actualisée que la version connectée.

Exemple de réponse :

		<envelope>
			<message type="MARKET_DEPTH_A" version="0.1">
				<market>
					<pitches>
						<pitch securityId="AUXLN" considerationCurrency="USD">
							<buyPrices>
								<price actionIndicator="B" quantity="0.1" limit="12510"/>
								<price actionIndicator="B" quantity="0.2" limit="12500"/>
								<price actionIndicator="B" quantity="0.1" limit="12490"/>
							</buyPrices>
							<sellPrices>
								<price actionIndicator="S" quantity="0.2" limit="12590"/>
								<price actionIndicator="S" quantity="0.1" limit="12600"/>
								<price actionIndicator="S" quantity="0.1" limit="12610"/>
							</sellPrices>
						</pitch>
					</pitches>
				</market>
			</message>
		</envelope>
		

Annulation d'un ordre

URL : https://or.bullionvault.fr/secure/cancel_order_xml.do

Passer un ordre

URL : https://or.bullionvault.fr/secure/place_order_xml.do

Exemple de réponse :

		<envelope>
			<message type="PLACE_ORDER_A" version="0.1">
				<order orderId="1080" clientTransRef="asdf" actionIndicator="B" securityId="AUXLN"
					considerationCurrency="USD" quantity="0.001" quantityMatched="0.001"
					totalConsideration="12.59" totalCommission="0.11" limit="13500" typeCode="TIL_CANCEL"
					orderTime="2005-06-02 14:14:24 UTC" goodUntil="" lastModified="2005-06-02 14:14:25 UTC"
					statusCode="DONE"/>
			</message>
		</envelope>
		

Consulter un solde

URL : https://or.bullionvault.fr/secure/view_balance_xml.do

simple=true

Exemple de réponse :

		<envelope>
			<message type="CLIENT_BALANCE_A" version="0.1">
				<clientBalance>
					<clientPositions>
						<clientPosition securityId="AUXLN" available="3.026" total="3.026"
							classNarrative="GOLD" totalValuation="40578.66" valuationCurrency="USD"/>
						<clientPosition securityId="AUXNY" available="5" total="5"
							classNarrative="GOLD" totalValuation="67050" valuationCurrency="USD"/>
						<clientPosition securityId="AUXZU" available="3.983" total="3.983"
							classNarrative="GOLD" totalValuation="53412.03" valuationCurrency="USD"/>
						<clientPosition securityId="EUR" available="39983" total="39983"
							classNarrative="CURRENCY" totalValuation="49059.15" valuationCurrency="USD"/>
						<clientPosition securityId="GBP" available="24799.04" total="24799.04"
							classNarrative="CURRENCY" totalValuation="45084.66" valuationCurrency="USD"/>
						<clientPosition securityId="USD" available="49954.9" total="49954.9"
							classNarrative="CURRENCY" totalValuation="49954.9" valuationCurrency="USD"/>
					</clientPositions>
				</clientBalance>
			</message>
		</envelope>
		

Suivre les ordres

URL : https://or.bullionvault.fr/secure/view_orders_xml.do

Exemple de réponse :

		<envelope>
			<message type="ORDERS_A" version="0.4" page="0" pageSize="20">
				<orders clientId="******">
					<order orderId="1080" clientTransRef="asdf" actionIndicator="B"
						securityId="AUXLN" considerationCurrency="USD" quantity="0.001" quantityMatched="0.001"
						totalConsideration="12.59" totalCommission="0.11" limit="13500" typeCode="TIL_CANCEL"
							orderTime="2005-06-02 14:14:24 UTC" goodUntil="" lastModified="2005-06-02 14:14:25 UTC"
							statusCode="DONE"/>
					<order orderId="1061" clientTransRef="050520115557474" actionIndicator="B"
						securityId="AUXNY" considerationCurrency="USD" quantity="0.002" quantityMatched="0.002"
						totalConsideration="26.8" totalCommission="0" limit="13400" typeCode="TIL_CANCEL"
							orderTime="2005-05-20 15:59:33 UTC" goodUntil="" lastModified="2005-05-20 15:59:45 UTC"
							statusCode="DONE"/>
					<order orderId="1041" clientTransRef="050520120214131" actionIndicator="B"
						securityId="AUXNY" considerationCurrency="USD" quantity="0.002" quantityMatched="0.002"
						totalConsideration="27" totalCommission="0" limit="13500" typeCode="TIL_CANCEL"
							orderTime="2005-05-20 12:02:16 UTC" goodUntil="" lastModified="2005-05-20 12:02:17 UTC"
							statusCode="DONE"/>
					<order orderId="1000" clientTransRef="abc123" actionIndicator="B"
						securityId="AUXLN" considerationCurrency="GBP" quantity="0.1" quantityMatched="0.025"
						totalConsideration="182.5" totalCommission="1.46" limit="7300" typeCode="TIL_CANCEL"
							orderTime="2005-05-19 09:21:21 UTC" goodUntil="" lastModified="2005-05-19 09:21:21 UTC"
							statusCode="CANCELLED"/>
				</orders>
			</message>
		</envelope>
		

Suivre un ordre en particulier

URL : https://or.bullionvault.fr/secure/view_single_order_xml.do

Exemple de réponse :

		<envelope>
			<message type="SINGLE_ORDER_A" version="0.1">
				<order orderId="1080" clientTransRef="asdf" actionIndicator="B" securityId="AUXLN" considerationCurrency="USD"
					quantity="0.001" quantityMatched="0.001" totalConsideration="12.59" totalCommission="0.11" limit="13500"
					typeCode="TIL_CANCEL" orderTime="2005-06-02 14:14:24 UTC" goodUntil="" lastModified="2005-06-02 14:14:25 UTC"
					statusCode="DONE"/>
			</message>
		</envelope>
		

Notes complémentaires

Le champ statusCode pour les réponses aux ordres a les valeurs suivantes :

Le champ tradeType pour les réponses des ordres a l'une des valeurs suivantes :

Configuration de l’unité de poids

URL : https://live.bullionvault.com/secure/api/v2/view_weight_unit_xml.do

Exemple de réponse :

		<envelope>
		<message type="UNIT_OF_WEIGHT_SETTING" version="0.1">
			<unitOfWeightSetting value="KG"/>
		</message>
		</envelope>
		

Actualisation de la configuration de l’unité de poids

URL : https://live.bullionvault.com/secure/api/v2/update_weight_unit_xml.do

Questions fréquentes

Question : Où puis-je trouver plus d'informations ? Réponse : Votre meilleur source d'information est de copier le client GUI. XML API et le client GUI sont fonctionnellement identiques - la véritable différence réside dans la présentation des données.

Question : Est-il possible d'ajouter un dispositif X ? Réponse : C'est possible même si le développement de XML API n'est pas une priorité actuelle. Vous pouvez nous envoyer vos suggestions par email. xmlapi@BullionVault.com

Question : Les données XML sont-elles actuelles ? Réponse : Aussi actuelle que les données GUI. Elles proviennent généralement de la même source.

Question : Un test public du serveur est-il disponible ? Réponse : Non, mais nous le prendrons en considération en cas de demande suffisante. Veuillez nous envoyer vos suggestions par email. xmlapi@BullionVault.com