Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rebrand to CSFloat #4

Merged
merged 1 commit into from
Aug 5, 2023
Merged

Rebrand to CSFloat #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<p align="center">
<img src="https://csgofloat.com/assets/full_logo.png" alt="CSGOFloat" width="400">
<img src="https://csfloat.com/assets/n_full_logo.png" alt="CSFloat" width="400">
<h1 align="center">
<a href="https://docs.csgofloat.com">API Docs</a>
<a href="https://docs.csfloat.com">API Docs</a>
<br>
<a href="https://github.com/csgofloat/docs/actions?query=workflow%3ABuild+branch%3Amain"><img src="https://github.com/slatedocs/slate/workflows/Build/badge.svg?branch=main" alt="Build Status"></a>
<a href="https://hub.docker.com/r/slatedocs/slate"><img src="https://img.shields.io/docker/v/slatedocs/slate?sort=semver" alt="Docker Version"/></a>
Expand All @@ -10,9 +10,9 @@

## Overview

This repo provides documentation on the CSGOFloat APIs including CSGOFloat Market and Inspect endpoints. This is forked from Slate and follows general markdown structure.
This repo provides documentation on the CSFloat APIs including CSFloat Market and Inspect endpoints. This is forked from Slate and follows general markdown structure.

[docs.csgofloat.com](https://docs.csgofloat.com)
[docs.csfloat.com](https://docs.csfloat.com)

Feel free to submit PRs or issues if you notice staleness.

20 changes: 10 additions & 10 deletions source/index.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ code_clipboard: true

# Introduction

Welcome to the CSGOFloat API! You can use our API to access CSGOFloat API endpoints such as market listings, inspect link retrieval, and more!
Welcome to the CSFloat API! You can use our API to access CSFloat API endpoints such as market listings, inspect link retrieval, and more!

You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

# Authentication

CSGOFloat uses API keys to allow access to the API. You can register a new CSGOFloat API key on your [profile](https://csgofloat.com/profile) under the "developer" tab.
CSFloat uses API keys to allow access to the API. You can register a new CSFloat API key on your [profile](https://csfloat.com/profile) under the "developer" tab.

CSGOFloat API expects for the API key to be included in most API requests. Endpoints that require an API Key will state so. The authorization header should look like the following:
CSFloat API expects for the API key to be included in most API requests. Endpoints that require an API Key will state so. The authorization header should look like the following:

`Authorization: <API-KEY>`

Expand All @@ -40,7 +40,7 @@ You must replace <code>&lt;API-KEY&gt;</code> with your personal API key.
## Get All Listings

```shell
curl "https://csgofloat.com/api/v1/listings"
curl "https://csfloat.com/api/v1/listings"
```

> The above command returns JSON structured like this:
Expand Down Expand Up @@ -115,11 +115,11 @@ curl "https://csgofloat.com/api/v1/listings"
]
```

This endpoint retrieves all active listings on CSGOFloat Market.
This endpoint retrieves all active listings on CSFloat Market.

### HTTP Request

`GET https://csgofloat.com/api/v1/listings`
`GET https://csfloat.com/api/v1/listings`

### Query Parameters

Expand All @@ -146,7 +146,7 @@ stickers | | Must be in the form: <code>ID&#124;POSITION?[,ID&#124;POSITION?...]
## Get a Specific Listing

```shell
curl "https://csgofloat.com/api/v1/listings/324288155723370196"
curl "https://csfloat.com/api/v1/listings/324288155723370196"
```

> The above command returns JSON structured like this:
Expand Down Expand Up @@ -222,7 +222,7 @@ This endpoint retrieves the details for a specific listing, regardless of whethe

### HTTP Request

`GET https://csgofloat.com/api/v1/listings/<ID>`
`GET https://csfloat.com/api/v1/listings/<ID>`

### URL Parameters

Expand All @@ -233,7 +233,7 @@ ID | The ID of the listing to retrieve
## List an item

```shell
curl -X POST "https://csgofloat.com/api/v1/listings" \
curl -X POST "https://csfloat.com/api/v1/listings" \
-H "Authorization: <API-KEY>; Content-Type: application/json" \
-d '{"asset_id": 21078095468, "type": "buy_now", "price": 8900, "description": "Just for show", "private": false}'
```
Expand Down Expand Up @@ -341,7 +341,7 @@ This endpoint lists the item specified by `asset_id`. Requires an authorization

### HTTP Request

`POST https://csgofloat.com/api/v1/listings`
`POST https://csfloat.com/api/v1/listings`

### Body Parameters

Expand Down
Loading