Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

1Forge

1Forge Forex Stream

WebSocket stream that delivers real-time bid/ask updates for subscribed forex and cryptocurrency pairs. Streaming is gated to paid plans.

Documentation Provider Profile APIs.io AsyncAPI GitHub

This event API exposes 2 operations across 1 channel, and defines 12 schemas. It is described by AsyncAPI 2.6.0, at version 2024.01.

The API connects through a single server, sockets.1forge.com/socket (wss).

2 operations 1 channels 12 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
2024.01
Base URL
wss://sockets.1forge.com/socket
Contact
1Forge Support
License
1Forge Forex API Terms of Use
Resource Areas
1

Channels & Operations 2

Across 1 channel, the API surfaces 2 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 2
SUB
stream
Receive incoming control or update frames from the 1Forge server.
receiveStreamFrames body
PUB
stream
Send control frames (login, subscribe/unsubscribe, heartbeat) to the 1Forge server.
sendStreamFrames body

Messages & Schemas 12

The contract defines 12 schemas that model the data carried by its messages. The most detailed is Quote (5 properties). Each schema is shown below with its type and property counts.

LoginPrompt
message
Server requests the client send its API key.
LoginCommand
message
Client sends API key for authentication.
PostLoginSuccess
message
Server confirms authentication succeeded.
SubscribeTo
message
Subscribe to updates for a single currency pair.
UnsubscribeFrom
message
Unsubscribe from updates for a single currency pair.
SubscribeToAll
message
Subscribe to updates for every available pair.
UnsubscribeFromAll
message
Unsubscribe from every pair currently subscribed.
Update
message
Real-time bid/ask/price update for a subscribed currency pair.
Heart
message
Server keep-alive prompt; clients respond with beat.
Beat
message
Client keep-alive response to a server heart frame.
ForceClose
message
Server instructs the client to close the connection.
Quote
object
A single bid/ask/price snapshot for a forex or cryptocurrency pair streamed over WebSocket.
5 properties 5 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

1forge-forex-stream-asyncapi.yml Raw ↑
#Currency Exchange#Forex#Cryptocurrency#Market Data#WebSocket#Streaming
← Back to 1 APIs
API Details
ID
1forge:1forge-forex-stream
Base URL
wss://sockets.1forge.com/socket
Docs
https://1forge.com/forex-data-api/api-documentation
Provider
1Forge
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network