api

command
v1.42.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2024 License: MIT Imports: 3 Imported by: 0

README

RFQ API

This is the canonical implementation of the RFQ API. It is a RESTful API that allows solvers to post quotes for given bridge routes.

Example

To retrieve quotes,

curl -X 'GET''http://api.synapseprotocol.com/quotes' -H 'accept: application/json'

For complete API documentation, including additional endpoints and query parameters, please refer to the API Documentation.

Documentation

Overview

Package main is the entry point for the RFQ API Server

Directories

Path Synopsis
Package client provides a client for the RFQ quoting API.
Package client provides a client for the RFQ quoting API.
Package cmd provides the command line interface for the RFQ API service.
Package cmd provides the command line interface for the RFQ API service.
Package config implements the configuration parser for the RFQ Quoter.
Package config implements the configuration parser for the RFQ Quoter.
db
Package db provides the database interfaces and types for the RFQ API.
Package db provides the database interfaces and types for the RFQ API.
sql
Package sql provides a common interface for starting sql-lite databases
Package sql provides a common interface for starting sql-lite databases
sql/base
Package base contains the base sql implementation
Package base contains the base sql implementation
sql/mysql
Package mysql contains a mysql db
Package mysql contains a mysql db
sql/sqlite
Package sqlite implements the sqlite package
Package sqlite implements the sqlite package
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
Package metadata provides a metadata service for the RFQ API.
Package metadata provides a metadata service for the RFQ API.
Package rest provides RESTful API services for RFQ
Package rest provides RESTful API services for RFQ

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL